org.ldaptive.templates

Class SearchTemplates

java.lang.Object

org.ldaptive.templates.SearchTemplates

public class SearchTemplates
extends java.lang.Object

Contains a list of common search filter templates that can be formatted for any given query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SearchTemplates.DefaultTermParser Adds each term as a filter parameter using the name 'termX' where X is the index of the term.
class	SearchTemplates.InitialTermParser Adds the first letter of each term as a filter parameter using the name 'initialX' where X is the index of the term.
static interface	SearchTemplates.TermParser Converts query terms into search filter parameters.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String[]	filterTemplates Search filter templates.
private java.lang.String	searchRestrictions Appended to every search filter to restrict results.
private SearchTemplates.TermParser[]	termParsers Term parsers for creating filter parameters.

Constructor Summary

Constructors

Constructor and Description
SearchTemplates(java.lang.String... templates) Creates a new search templates.

Method Summary

Modifier and Type	Method and Description
private java.lang.String	concatFilters(java.lang.String... filters) Concatenates the supplied filters into a single filter will all arguments ANDED together.
SearchFilter[]	format(Query query) Creates the search filters using configured templates and the supplied query.
java.lang.String	getSearchRestrictions() Returns the filter to use for search restrictions.
SearchTemplates.TermParser[]	getTermParsers() Returns the term parsers used for creating filter parameters.
void	setSearchRestrictions(java.lang.String restrictions) Sets the filter to use for search restrictions.
void	setTermParsers(SearchTemplates.TermParser... parsers) Sets the term parsers used for creating filter parameters.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

filterTemplates

private final java.lang.String[] filterTemplates

Search filter templates.

searchRestrictions

private java.lang.String searchRestrictions

Appended to every search filter to restrict results.

termParsers

private SearchTemplates.TermParser[] termParsers

Term parsers for creating filter parameters.

Constructor Detail

SearchTemplates

public SearchTemplates(java.lang.String... templates)

Creates a new search templates.

Parameters:

templates - list of search filters

Method Detail

getSearchRestrictions

public java.lang.String getSearchRestrictions()

Returns the filter to use for search restrictions.

Returns:

search restrictions

setSearchRestrictions

public void setSearchRestrictions(java.lang.String restrictions)

Sets the filter to use for search restrictions.

Parameters:

restrictions - search restrictions

getTermParsers

public SearchTemplates.TermParser[] getTermParsers()

Returns the term parsers used for creating filter parameters.

Returns:

term parsers

setTermParsers

public void setTermParsers(SearchTemplates.TermParser... parsers)

Sets the term parsers used for creating filter parameters.

Parameters:

parsers - term parsers

format

public SearchFilter[] format(Query query)

Creates the search filters using configured templates and the supplied query.

Parameters:

query - to create search filter with

Returns:

search filters

concatFilters

private java.lang.String concatFilters(java.lang.String... filters)

Concatenates the supplied filters into a single filter will all arguments ANDED together. Null array values are ignored.

Parameters:

filters - to concatenate

Returns:

search filter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object