org.ldaptive.templates
Class SearchTemplates

java.lang.Object
  org.ldaptive.templates.SearchTemplates

public class SearchTemplates
extends Object

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

Version:

$Revision $ $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $

Author:

Middleware Services

Nested Class Summary

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.

Constructor Summary

SearchTemplates(String... templates)
Creates a new search templates.

Method Summary

org.ldaptive.SearchFilter[]	format(Query query) Creates the search filters using configured templates and the supplied query.
String	getSearchRestrictions() Returns the filter to use for search restrictions.
SearchTemplates.TermParser[]	getTermParsers() Returns the term parsers used for creating filter parameters.
void	setSearchRestrictions(String restrictions) Sets the filter to use for search restrictions.
void	setTermParsers(SearchTemplates.TermParser... parsers) Sets the term parsers used for creating filter parameters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTemplates

public SearchTemplates(String... templates)

Creates a new search templates.

Parameters:

templates - list of search filters

Method Detail

getSearchRestrictions

public String getSearchRestrictions()

Returns the filter to use for search restrictions.

Returns:

search restrictions

setSearchRestrictions

public void setSearchRestrictions(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 org.ldaptive.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

toString

public String toString()

Overrides:

toString in class Object