Package net.solarnetwork.central.support

Class ObjectSearchFilters<T extends Filter>

java.lang.Object

net.solarnetwork.central.support.ObjectSearchFilters<T>

Type Parameters:

T - the object to filter on

All Implemented Interfaces:

Cloneable, ObjectCriteria<T>

public class ObjectSearchFilters<T extends Filter>
extends Object
implements Cloneable, ObjectCriteria<T>

Collection of object search filters.

Nested Class Summary

Nested classes/interfaces inherited from interface net.solarnetwork.central.dao.ObjectCriteria

ObjectCriteria.JoinType, ObjectCriteria.MatchType

Constructor Summary

Constructors

Constructor	Description
ObjectSearchFilters(ObjectCriteria.JoinType joinType)	Construct a new ObjectSearchFilters object with a join type.
ObjectSearchFilters(ObjectCriteria.JoinType joinType, T filter)	Construct a search filters object out of a single filter, using ObjectCriteria.MatchType.EQUAL.
ObjectSearchFilters(ObjectCriteria.JoinType joinType, T filter, ObjectCriteria.JoinType filterJoinType)	Construct a search filters object out of a single filter, using ObjectCriteria.MatchType.EQUAL.
ObjectSearchFilters(T filter)	Construct a search filters object out of a single filter, using ObjectCriteria.JoinType.AND and ObjectCriteria.MatchType.EQUAL.

Method Summary

Modifier and Type	Method	Description
ObjectSearchFilters<T>	addNestedFilters(ObjectCriteria.JoinType nestedJoinType)	Add a new nested ObjectSearchFilters object to this one.
void	addObjectSearchFilter(ObjectSearchFilter<T> filter)	Add a new ObjectSearchFilter to this object.
void	addObjectSearchFilter(T filter, ObjectCriteria.MatchType mode, ObjectCriteria.JoinType joinType)	Add a new ObjectSearchFilter to this object.
void	appendLdapSearchFilter(StringBuilder buf)	Generate a complete search filter string of this object into a StringBuffer.
String	asLdapSearchFilterString()	Generate a complete LDAP search filter string of this object.
Object	clone()
ObjectCriteria.JoinType	getJoinType()
List<ObjectSearchFilters<T>>	getNestedFilters()
Integer	getResultMax()	Get the maximum number of results.
Integer	getResultOffset()	Get a result offset.
T	getSimpleFilter()	Get a simple filter object.
ObjectCriteria.JoinType	getSimpleJoinType()	Get the simple filter join type.
ObjectCriteria.MatchType	getSimpleMatchType()	Get the simple filter match type.
void	setFilters(List<ObjectSearchFilter<T>> newFilters)
void	setJoinType(ObjectCriteria.JoinType newJoinType)
void	setNestedFilters(List<ObjectSearchFilters<T>> newNestedLdapSearchFilters)
void	setResultMax(Integer resultMax)
void	setResultOffset(Integer resultOffset)
String	toString()	Return an LDAP search filter string.

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectSearchFilters

public ObjectSearchFilters(ObjectCriteria.JoinType joinType)

Construct a new ObjectSearchFilters object with a join type.

Parameters:

joinType - the logical join type

ObjectSearchFilters

public ObjectSearchFilters(T filter)

Construct a search filters object out of a single filter, using ObjectCriteria.JoinType.AND and ObjectCriteria.MatchType.EQUAL.

Parameters:

filter - the object to filter on

ObjectSearchFilters

public ObjectSearchFilters(ObjectCriteria.JoinType joinType,
 T filter)

Construct a search filters object out of a single filter, using ObjectCriteria.MatchType.EQUAL.

Parameters:

joinType - the logical join type, used for nested join and the given filter

filter - the object to filter on

ObjectSearchFilters

public ObjectSearchFilters(ObjectCriteria.JoinType joinType,
 T filter,
 ObjectCriteria.JoinType filterJoinType)

Construct a search filters object out of a single filter, using ObjectCriteria.MatchType.EQUAL.

Parameters:

joinType - the logical join type

filter - the object to filter on

filterJoinType - the filter object join type

Method Details

addNestedFilters

public ObjectSearchFilters<T> addNestedFilters(ObjectCriteria.JoinType nestedJoinType)

Add a new nested ObjectSearchFilters object to this one.

This allows for creating complex logical filters. See the class description for an example of this.

Parameters:

nestedJoinType - the logical join type

Returns:

the new nested ObjectSearchFilters object

addObjectSearchFilter

public void addObjectSearchFilter(ObjectSearchFilter<T> filter)

Add a new ObjectSearchFilter to this object.

Parameters:

filter - the filter

addObjectSearchFilter

public void addObjectSearchFilter(T filter,
 ObjectCriteria.MatchType mode,
 ObjectCriteria.JoinType joinType)

Add a new ObjectSearchFilter to this object.

Parameters:

filter - the filter to add

mode - the search filter mode

joinType - the join type

appendLdapSearchFilter

public void appendLdapSearchFilter(StringBuilder buf)

Generate a complete search filter string of this object into a StringBuffer.

Parameters:

buf - buffer to append to

asLdapSearchFilterString

public String asLdapSearchFilterString()

Generate a complete LDAP search filter string of this object.

Returns:

String

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Return an LDAP search filter string.

This simply calls asLdapSearchFilterString().

Overrides:

toString in class Object

Returns:

String

getSimpleFilter

public T getSimpleFilter()

Description copied from interface: ObjectCriteria

Get a simple filter object.

Specified by:

getSimpleFilter in interface ObjectCriteria<T extends Filter>

Returns:

simple filter objecct

getSimpleJoinType

public ObjectCriteria.JoinType getSimpleJoinType()

Description copied from interface: ObjectCriteria

Get the simple filter join type.

Specified by:

getSimpleJoinType in interface ObjectCriteria<T extends Filter>

Returns:

join type

getSimpleMatchType

public ObjectCriteria.MatchType getSimpleMatchType()

Description copied from interface: ObjectCriteria

Get the simple filter match type.

Specified by:

getSimpleMatchType in interface ObjectCriteria<T extends Filter>

Returns:

match type

getJoinType

public ObjectCriteria.JoinType getJoinType()

getNestedFilters

public List<ObjectSearchFilters<T>> getNestedFilters()

setFilters

public void setFilters(List<ObjectSearchFilter<T>> newFilters)

setJoinType

public void setJoinType(ObjectCriteria.JoinType newJoinType)

setNestedFilters

public void setNestedFilters(List<ObjectSearchFilters<T>> newNestedLdapSearchFilters)

getResultOffset

public Integer getResultOffset()

Description copied from interface: ObjectCriteria

Get a result offset.

Specified by:

getResultOffset in interface ObjectCriteria<T extends Filter>

Returns:

result offset

setResultOffset

public void setResultOffset(Integer resultOffset)

getResultMax

public Integer getResultMax()

Description copied from interface: ObjectCriteria

Get the maximum number of results.

Specified by:

getResultMax in interface ObjectCriteria<T extends Filter>

Returns:

result max

setResultMax

public void setResultMax(Integer resultMax)