org.apache.directory.shared.ldap.codec.search
Class SubstringFilter

java.lang.Object
  extended byorg.apache.directory.shared.asn1.Asn1Object
      extended byorg.apache.directory.shared.ldap.codec.search.Filter
          extended byorg.apache.directory.shared.ldap.codec.search.SubstringFilter

public class SubstringFilter
extends Filter

A Object that stores the substring filter. A substring filter follow this grammar : substring = attr "=" ([initial] any [final] | (initial [any] [final) | ([initial] [any] final) initial = value any = "*" *(value "*") final = value

Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object
parent
 
Constructor Summary
SubstringFilter()
          The constructor.
 
Method Summary
 void addAnySubstrings(LdapString anySubstrings)
          Add a internal substring
 int computeLength()
          Compute the SubstringFilter length SubstringFilter : 0xA4 L1 | +--> 0x04 L2 type +--> 0x30 L3 | [+--> 0x80 L4 initial] [+--> 0x81 L5-1 any] [+--> 0x81 L5-2 any] [+--> ...
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encode the Substrings Filter to a PDU.
 java.util.ArrayList getAnySubstrings()
          Get the internal substrings
 LdapString getFinalSubstrings()
          Get the final substring
 LdapString getInitialSubstrings()
          Get the initial substring
 int getSubstringsLength()
           
 LdapString getType()
          Get the attribute
 void setFinalSubstrings(LdapString finalSubstrings)
          Set the final substring
 void setInitialSubstrings(LdapString initialSubstrings)
          Set the initial substring
 void setSubstringsLength(int substringsLength)
           
 void setType(LdapString type)
          Set the attribute to match
 java.lang.String toString()
          Return a string compliant with RFC 2254 representing a Substring filter
 
Methods inherited from class org.apache.directory.shared.asn1.Asn1Object
addLength, getCurrentLength, getExpectedLength, getParent, setCurrentLength, setExpectedLength, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SubstringFilter

public SubstringFilter()
The constructor. We will create the 'any' subsring arraylist with only one element.

Method Detail

getAnySubstrings

public java.util.ArrayList getAnySubstrings()
Get the internal substrings

Returns:
Returns the anySubstrings.

addAnySubstrings

public void addAnySubstrings(LdapString anySubstrings)
Add a internal substring

Parameters:
anySubstrings - The anySubstrings to set.

getFinalSubstrings

public LdapString getFinalSubstrings()
Get the final substring

Returns:
Returns the finalSubstrings.

setFinalSubstrings

public void setFinalSubstrings(LdapString finalSubstrings)
Set the final substring

Parameters:
finalSubstrings - The finalSubstrings to set.

getInitialSubstrings

public LdapString getInitialSubstrings()
Get the initial substring

Returns:
Returns the initialSubstrings.

setInitialSubstrings

public void setInitialSubstrings(LdapString initialSubstrings)
Set the initial substring

Parameters:
initialSubstrings - The initialSubstrings to set.

getType

public LdapString getType()
Get the attribute

Returns:
Returns the type.

setType

public void setType(LdapString type)
Set the attribute to match

Parameters:
type - The type to set.

getSubstringsLength

public int getSubstringsLength()
Returns:
Returns the substringsLength.

setSubstringsLength

public void setSubstringsLength(int substringsLength)
Parameters:
substringsLength - The substringsLength to set.

computeLength

public int computeLength()
Compute the SubstringFilter length SubstringFilter : 0xA4 L1 | +--> 0x04 L2 type +--> 0x30 L3 | [+--> 0x80 L4 initial] [+--> 0x81 L5-1 any] [+--> 0x81 L5-2 any] [+--> ... [+--> 0x81 L5-i any] [+--> ... [+--> 0x81 L5-n any] [+--> 0x82 L6 final]


encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.shared.asn1.codec.EncoderException
Encode the Substrings Filter to a PDU. Substrings Filter : 0xA4 LL 0x30 LL substringsFilter 0x04 LL type 0x30 LL substrings sequence | 0x80 LL initial | / [0x81 LL any]* |/ [0x82 LL final] +--[0x81 LL any]+ \ [0x82 LL final] \ 0x82 LL final

Parameters:
buffer - The buffer where to put the PDU
Returns:
The PDU.
Throws:
org.apache.directory.shared.asn1.codec.EncoderException

toString

public java.lang.String toString()
Return a string compliant with RFC 2254 representing a Substring filter

Returns:
The substring filter string


Copyright © 2003-2006 . All Rights Reserved.