org.apache.directory.api.ldap.codec.search

Class SubstringFilter

java.lang.Object

org.apache.directory.api.ldap.codec.search.Filter

org.apache.directory.api.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

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	anySubstrings The any filter.
private java.lang.String	finalSubstrings The final filter
private java.lang.String	initialSubstrings The initial filter
private int	substringsFilterLength Temporary storage for substringsFilter length
private int	substringsFilterSequenceLength Temporary storage for substringsFilter sequence length
private int	substringsLength This member is used to control the length of the three parts of the substring filter
private java.lang.String	type The substring filter type (an attributeDescription)

Fields inherited from class org.apache.directory.api.ldap.codec.search.Filter

parent, parentTlvId, tlvId

Constructor Summary

Constructors

Constructor and Description
SubstringFilter() The constructor.
SubstringFilter(int tlvId) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addAnySubstrings(java.lang.String any) 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.List<java.lang.String>	getAnySubstrings() Get the internal substrings
java.lang.String	getFinalSubstrings() Get the final substring
java.lang.String	getInitialSubstrings() Get the initial substring
int	getSubstringsLength()
java.lang.String	getType() Get the attribute
void	setFinalSubstrings(java.lang.String finalSubstrings) Set the final substring
void	setInitialSubstrings(java.lang.String initialSubstrings) Set the initial substring
void	setSubstringsLength(int substringsLength)
void	setType(java.lang.String 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.api.ldap.codec.search.Filter

getParent, getParentTlvId, getTlvId, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

type

private java.lang.String type

The substring filter type (an attributeDescription)

substringsLength

private int substringsLength

This member is used to control the length of the three parts of the substring filter

initialSubstrings

private java.lang.String initialSubstrings

The initial filter

anySubstrings

private java.util.List<java.lang.String> anySubstrings

The any filter. It's a list of LdapString

finalSubstrings

private java.lang.String finalSubstrings

The final filter

substringsFilterLength

private int substringsFilterLength

Temporary storage for substringsFilter length

substringsFilterSequenceLength

private int substringsFilterSequenceLength

Temporary storage for substringsFilter sequence length

Constructor Detail

SubstringFilter

public SubstringFilter(int tlvId)

The constructor. We will create the 'any' subsring arraylist with only one element.

SubstringFilter

public SubstringFilter()

The constructor. We will create the 'any' subsring arraylist with only one element.

Method Detail

getAnySubstrings

public java.util.List<java.lang.String> getAnySubstrings()

Get the internal substrings

Returns:

Returns the anySubstrings.

addAnySubstrings

public void addAnySubstrings(java.lang.String any)

Add a internal substring

Parameters:

any - The anySubstrings to set.

getFinalSubstrings

public java.lang.String getFinalSubstrings()

Get the final substring

Returns:

Returns the finalSubstrings.

setFinalSubstrings

public void setFinalSubstrings(java.lang.String finalSubstrings)

Set the final substring

Parameters:

finalSubstrings - The finalSubstrings to set.

getInitialSubstrings

public java.lang.String getInitialSubstrings()

Get the initial substring

Returns:

Returns the initialSubstrings.

setInitialSubstrings

public void setInitialSubstrings(java.lang.String initialSubstrings)

Set the initial substring

Parameters:

initialSubstrings - The initialSubstrings to set.

getType

public java.lang.String getType()

Get the attribute

Returns:

Returns the type.

setType

public void setType(java.lang.String 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]

Specified by:

computeLength in class Filter

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws 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

Specified by:

encode in class Filter

Parameters:

buffer - The buffer where to put the PDU

Returns:

The PDU.

Throws:

EncoderException

toString

public java.lang.String toString()

Return a string compliant with RFC 2254 representing a Substring filter

Overrides:

toString in class java.lang.Object

Returns:

The substring filter string