fr.ifremer.allegro
Class CriteriaSearchParameter

java.lang.Object
  fr.ifremer.allegro.SearchParameter
      fr.ifremer.allegro.CriteriaSearchParameter

All Implemented Interfaces:

java.io.Serializable

public class CriteriaSearchParameter
extends SearchParameter

A CriteriaSearchParameter represents a parameter for a CriteriaSearch.

The parameterValue is the actual value to be searched for.

The parameterPattern describes the actual parameter which shall be considered for the search. It contains the dot-seperated path and the name of the parameter starting at the rootEntity of the actual CriteriaSearch. The pattern of a the street of an address of a person would look like address.street (assuming the entity structure to be aPerson.getAddress().getStreet()).

Usually, if a parameter is null (or if the parameter is of type String and empty), it is not considered for a search. If searchIfNull is true it is explicitly searched for the parameter to be null (or empty if the parameter is of type String).

The comparator defines the comparator for the parameter. For parameters of type String the default comparator is the LIKE_COMPARATOR. The EQUAL_COMPARATOR is default for other parameters.

Author:

Stefan Reichert, Peter Friese, Chad Brandon

See Also:

Serialized Form

Field Summary

static java.util.regex.Pattern	PATTERN
static int	RELEVANCE_UNSET Order relevance not set

Fields inherited from class fr.ifremer.allegro.SearchParameter

EQUAL_COMPARATOR, GREATER_THAN_COMPARATOR, GREATER_THAN_OR_EQUAL_COMPARATOR, IN_COMPARATOR, INSENSITIVE_LIKE_COMPARATOR, LESS_THAN_COMPARATOR, LESS_THAN_OR_EQUAL_COMPARATOR, LIKE_COMPARATOR, MATCH_ANYWHERE, MATCH_END, MATCH_EXACT, MATCH_START, NOT_EQUAL_COMPARATOR, NOT_IN_COMPARATOR, NOT_INSENSITIVE_LIKE_COMPARATOR, NOT_LIKE_COMPARATOR, NOT_NULL_COMPARATOR, NULL_COMPARATOR, ORDER_ASC, ORDER_DESC, ORDER_UNSET

Constructor Summary

CriteriaSearchParameter(java.lang.Object parameterValue, java.lang.String parameterPattern)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.Object parameterValue, java.lang.String parameterPattern, boolean searchIfNull)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.Object parameterValue, java.lang.String parameterPattern, boolean searchIfNull, int comparator)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.Object parameterValue, java.lang.String parameterPattern, boolean searchIfNull, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.Object parameterValue, java.lang.String parameterPattern, int comparator)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.Object parameterValue, java.lang.String parameterPattern, int comparator, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.Object parameterValue, java.lang.String parameterPattern, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.String[] parameterValue, java.lang.String parameterPattern)
Constructor for CriteriaSearchParameter for a String[] parameter.

CriteriaSearchParameter(java.lang.String[] parameterValue, java.lang.String parameterPattern, boolean searchIfNull)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.String[] parameterValue, java.lang.String parameterPattern, boolean searchIfNull, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.String[] parameterValue, java.lang.String parameterPattern, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.String parameterValue, java.lang.String parameterPattern)
Constructor for CriteriaSearchParameter for a String parameter.

CriteriaSearchParameter(java.lang.String parameterValue, java.lang.String parameterPattern, boolean searchIfNull)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.String parameterValue, java.lang.String parameterPattern, boolean searchIfNull, int comparator, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.String parameterValue, java.lang.String parameterPattern, boolean searchIfNull, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.

CriteriaSearchParameter(java.lang.String parameterValue, java.lang.String parameterPattern, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.

Method Summary

org.hibernate.criterion.MatchMode	getMatchMode()
int	getOrderDirection()
int	getOrderRelevance()
java.lang.String	getParameterName()
java.lang.String	getParameterPattern()
java.lang.Object	getParameterValue()
void	setMatchMode(org.hibernate.criterion.MatchMode matchMode) Sets the hibernate matchmode of this parameter.
void	setOrderDirection(int orderDirection) Sets the ordering for this parameter.
void	setOrderRelevance(int relevance) Sets the ordering relevance for this parameter.
void	setParameterPattern(java.lang.String parameterPattern) Sets the pattern of this parameter.
void	setParameterValue(java.lang.Object parameterValue) Sets the value of this parameter.

Methods inherited from class fr.ifremer.allegro.SearchParameter

getComparator, getMatch, getName, getOrder, getValue, isSearchIfNull, setComparator, setMatch, setName, setOrder, setSearchIfNull, setValue

Methods inherited from class java.lang.Object

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

Field Detail

PATTERN

public static final java.util.regex.Pattern PATTERN

RELEVANCE_UNSET

public static final int RELEVANCE_UNSET

Order relevance not set

See Also:

Constant Field Values

Constructor Detail

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.Object parameterValue,
                               java.lang.String parameterPattern)

Constructor for CriteriaSearchParameter. Sets searchIfNull to false and uses the EQUAL_COMPARATOR.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.String parameterValue,
                               java.lang.String parameterPattern)

Constructor for CriteriaSearchParameter for a String parameter. Sets searchIfNull to false and uses the LIKE_COMPARATOR.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.String[] parameterValue,
                               java.lang.String parameterPattern)

Constructor for CriteriaSearchParameter for a String[] parameter. Sets searchIfNull to false and uses the LIKE_COMPARATOR.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.Object parameterValue,
                               java.lang.String parameterPattern,
                               int comparator)

Constructor for CriteriaSearchParameter. Sets searchIfNull to false.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.Object parameterValue,
                               java.lang.String parameterPattern,
                               boolean searchIfNull)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

searchIfNull - Indicates whether the query should contain an IS NULL if the parameter is null.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.String parameterValue,
                               java.lang.String parameterPattern,
                               boolean searchIfNull)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

searchIfNull - Indicates whether the query should contain an IS NULL if the parameter is null.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.String[] parameterValue,
                               java.lang.String parameterPattern,
                               boolean searchIfNull)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

searchIfNull - Indicates whether the query should contain an IS NULL if the parameter is null.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.Object parameterValue,
                               java.lang.String parameterPattern,
                               boolean searchIfNull,
                               int comparator)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

searchIfNull - Indicates whether the query should contain an IS NULL if the parameter is null.

comparator - Indicates what comparator is to be used (e.g. like, =, <, ...).

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.Object parameterValue,
                               java.lang.String parameterPattern,
                               boolean searchIfNull,
                               org.hibernate.criterion.MatchMode matchMode)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

searchIfNull - Indicates whether the query should contain an IS NULL if the parameter is null.

matchMode - The hibernate matchmode to be used in string comparisons.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.String parameterValue,
                               java.lang.String parameterPattern,
                               boolean searchIfNull,
                               org.hibernate.criterion.MatchMode matchMode)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

searchIfNull - Indicates whether the query should contain an IS NULL if the parameter is null.

matchMode - The hibernate matchmode to be used in string comparisons.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.String[] parameterValue,
                               java.lang.String parameterPattern,
                               boolean searchIfNull,
                               org.hibernate.criterion.MatchMode matchMode)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

searchIfNull - Indicates whether the query should contain an IS NULL if the parameter is null.

matchMode - The hibernate matchmode to be used in string comparisons.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.String parameterValue,
                               java.lang.String parameterPattern,
                               boolean searchIfNull,
                               int comparator,
                               org.hibernate.criterion.MatchMode matchMode)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

searchIfNull - Indicates whether the query should contain an IS NULL if the parameter is null.

comparator - Indicates what comparator is to be used (e.g. like, =, <, ...).

matchMode - The hibernate matchmode to be used in string comparisons.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.Object parameterValue,
                               java.lang.String parameterPattern,
                               int comparator,
                               org.hibernate.criterion.MatchMode matchMode)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

comparator - Indicates what comparator is to be used (e.g. like, =, <, ...).

matchMode - The hibernate matchmode to be used in string comparisons.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.Object parameterValue,
                               java.lang.String parameterPattern,
                               org.hibernate.criterion.MatchMode matchMode)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

matchMode - The hibernate matchmode to be used in string comparisons.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.String parameterValue,
                               java.lang.String parameterPattern,
                               org.hibernate.criterion.MatchMode matchMode)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

matchMode - The hibernate matchmode to be used in string comparisons.

CriteriaSearchParameter

public CriteriaSearchParameter(java.lang.String[] parameterValue,
                               java.lang.String parameterPattern,
                               org.hibernate.criterion.MatchMode matchMode)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValue - The actual value of the parameter.

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

matchMode - The hibernate matchmode to be used in string comparisons.

Method Detail

getParameterPattern

public java.lang.String getParameterPattern()

Returns:

The pattern of this parameter (dot-seperated path e.g. person.address.street).

setParameterPattern

public void setParameterPattern(java.lang.String parameterPattern)

Sets the pattern of this parameter.

Parameters:

parameterPattern - The pattern of this parameter (dot-seperated path e.g. person.address.street).

getParameterName

public java.lang.String getParameterName()

Returns:

The last part of the parameter pattern, i.e. the attribute name.

getParameterValue

public java.lang.Object getParameterValue()

Returns:

The value of this parameter.

setParameterValue

public void setParameterValue(java.lang.Object parameterValue)

Sets the value of this parameter.

Parameters:

parameterValue - The value of this parameter.

getMatchMode

public org.hibernate.criterion.MatchMode getMatchMode()

Returns:

The hibernate matchmode of this parameter.

setMatchMode

public void setMatchMode(org.hibernate.criterion.MatchMode matchMode)

Sets the hibernate matchmode of this parameter.

Parameters:

matchMode - The hibernate matchmode.

getOrderDirection

public int getOrderDirection()

Returns:

The order (ascending or descending) for this parameter.

See Also:

ORDER_ASC, ORDER_DESC, ORDER_UNSET

setOrderDirection

public void setOrderDirection(int orderDirection)

Sets the ordering for this parameter.

Parameters:

orderDirection - The ordering for this parameter.

getOrderRelevance

public int getOrderRelevance()

Returns:

The relevance for this parameter.

See Also:

RELEVANCE_UNSET

setOrderRelevance

public void setOrderRelevance(int relevance)

Sets the ordering relevance for this parameter.

Parameters:

order - The ordering relevance for this parameter.