Package org.ldaptive.filter

Class AbstractFilterFunction

java.lang.Object

org.ldaptive.filter.AbstractFilterFunction

All Implemented Interfaces:

FilterFunction

Direct Known Subclasses:

DefaultFilterFunction, RegexFilterFunction

public abstract class AbstractFilterFunction
extends Object
implements FilterFunction

Base implementation to parse an LDAP search filter string.

Field Summary

Fields

Modifier and Type	Field	Description
private static int	MAX_FILTER_DEPTH	Maximum filter depth.

Constructor Summary

Constructors

Constructor	Description
AbstractFilterFunction()

Method Summary

Modifier and Type	Method	Description
private int	findMatchingParenPosition(String filter, int start)	Returns the index in the supplied filter of the closing paren that matches the opening paren at the start of the filter.
Filter	parse(String filter)	Parses the supplied string representation of a filter.
protected abstract Filter	parseFilterComp(String filter)	Inspects the supplied filter string and creates the type of filter it represents.
private FilterSet	readFilterSet(FilterSet set, String filter, int start, int end, int depth)	Reads the supplied filter using the supplied indices and adds them to the supplied filter set.
private Filter	readNextComponent(String filter, int depth)	Reads the next component contained in the supplied filter.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FILTER_DEPTH

private static final int MAX_FILTER_DEPTH

Maximum filter depth.

See Also:

Constant Field Values

Constructor Detail

AbstractFilterFunction

public AbstractFilterFunction()

Method Detail

parse

public Filter parse(String filter)
             throws FilterParseException

Description copied from interface: FilterFunction

Parses the supplied string representation of a filter.

Specified by:

parse in interface FilterFunction

Parameters:

filter - to parse

Returns:

parsed filter

Throws:

FilterParseException - if the supplied filter is invalid

readNextComponent

private Filter readNextComponent(String filter,
                                 int depth)
                          throws FilterParseException

Reads the next component contained in the supplied filter.

Parameters:

filter - to parse

depth - counter to track invocation depth

Returns:

search filter

Throws:

FilterParseException - if filter does not start with '(' and end with ')'

readFilterSet

private FilterSet readFilterSet(FilterSet set,
                                String filter,
                                int start,
                                int end,
                                int depth)
                         throws FilterParseException

Reads the supplied filter using the supplied indices and adds them to the supplied filter set.

Parameters:

set - to update

filter - to parse

start - position in filter

end - position in filter

depth - counter to track invocation depth

Returns:

the supplied filter set with components added from filter

Throws:

FilterParseException - if filter doesn't start with '(' and containing a matching ')'

findMatchingParenPosition

private int findMatchingParenPosition(String filter,
                                      int start)
                               throws FilterParseException

Returns the index in the supplied filter of the closing paren that matches the opening paren at the start of the filter.

Parameters:

filter - to search

start - position of the opening paren

Returns:

index of the matching paren

Throws:

FilterParseException - if filter is null, empty or does not begin with '('

parseFilterComp

protected abstract Filter parseFilterComp(String filter)
                                   throws FilterParseException

Inspects the supplied filter string and creates the type of filter it represents.

Parameters:

filter - to inspect

Returns:

search filter

Throws:

FilterParseException - if filter is invalid