org.apache.directory.api.dsmlv2.request

Class SubstringFilter

java.lang.Object

org.apache.directory.api.dsmlv2.request.Filter

org.apache.directory.api.dsmlv2.request.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 java.lang.String	type The substring filter type (an attributeDescription)

Fields inherited from class org.apache.directory.api.dsmlv2.request.Filter

parent

Constructor Summary

Constructors

Constructor and Description
SubstringFilter()

Method Summary

Modifier and Type	Method and Description
void	addAnySubstrings(java.lang.String any) Add a internal substring
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
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	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.dsmlv2.request.Filter

getParent, 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)

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

Constructor Detail

SubstringFilter

public SubstringFilter()

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.

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