org.ldaptive.templates

Class Query

java.lang.Object

org.ldaptive.templates.Query

public class Query
extends java.lang.Object

Contains data associated with a query request.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	EMPTY_STRING_ARRAY Used for setting empty terms.
private java.lang.Integer	fromResult Start index of search results to return.
private java.lang.String[]	returnAttributes Attributes to return with the ldap query.
private java.lang.String	searchRestrictions Additional restrictions to place on every query.
private java.lang.String[]	terms Query separated into terms.
private java.lang.Integer	toResult End index of search results to return.

Constructor Summary

Constructors

Constructor and Description
Query(java.lang.String query) Parses the query from a string into query terms.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getFromResult() Returns the from result.
java.lang.String[]	getReturnAttributes() Returns the return attributes.
java.lang.String	getSearchRestrictions() Returns the search restrictions.
java.lang.String[]	getTerms() Returns the terms.
java.lang.Integer	getToResult() Returns the to result.
void	setFromResult(java.lang.Integer i) Sets the index of the result to begin searching.
void	setReturnAttributes(java.lang.String[] attrs) Sets the return attributes.
void	setSearchRestrictions(java.lang.String restrictions) Sets the search restrictions.
void	setToResult(java.lang.Integer i) Sets the index of the result to stop searching.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING_ARRAY

private static final java.lang.String[] EMPTY_STRING_ARRAY

Used for setting empty terms.

terms

private final java.lang.String[] terms

Query separated into terms.

returnAttributes

private java.lang.String[] returnAttributes

Attributes to return with the ldap query.

searchRestrictions

private java.lang.String searchRestrictions

Additional restrictions to place on every query.

fromResult

private java.lang.Integer fromResult

Start index of search results to return.

toResult

private java.lang.Integer toResult

End index of search results to return.

Constructor Detail

Query

public Query(java.lang.String query)

Parses the query from a string into query terms.

Parameters:

query - to parse

Method Detail

getTerms

public java.lang.String[] getTerms()

Returns the terms.

Returns:

query terms

setReturnAttributes

public void setReturnAttributes(java.lang.String[] attrs)

Sets the return attributes.

Parameters:

attrs - return attributes

getReturnAttributes

public java.lang.String[] getReturnAttributes()

Returns the return attributes.

Returns:

return attributes

setSearchRestrictions

public void setSearchRestrictions(java.lang.String restrictions)

Sets the search restrictions.

Parameters:

restrictions - search restrictions

getSearchRestrictions

public java.lang.String getSearchRestrictions()

Returns the search restrictions.

Returns:

search restrictions

setFromResult

public void setFromResult(java.lang.Integer i)

Sets the index of the result to begin searching.

Parameters:

i - from index

getFromResult

public java.lang.Integer getFromResult()

Returns the from result.

Returns:

from result

setToResult

public void setToResult(java.lang.Integer i)

Sets the index of the result to stop searching.

Parameters:

i - to result

getToResult

public java.lang.Integer getToResult()

Returns the to result.

Returns:

to result

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object