fr.ifremer.adagio.core.dao

Class CriteriaSearchParameter

Object

SearchParameter

CriteriaSearchParameter

All Implemented Interfaces:

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-separated 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

Fields

Modifier and Type	Field and Description
static Pattern	PATTERN Compiled pattern \\.
static int	RELEVANCE_UNSET Order relevance not set

Fields inherited from class SearchParameter

EMPTY_COMPARATOR, 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_EMPTY_COMPARATOR, 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

Constructors

Constructor and Description
CriteriaSearchParameter(Object parameterValueIn, String parameterPatternIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(Object parameterValueIn, String parameterPatternIn, boolean searchIfNull) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(Object parameterValueIn, String parameterPatternIn, boolean searchIfNull, int comparatorIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(Object parameterValueIn, String parameterPatternIn, boolean searchIfNull, MatchMode matchModeIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(Object parameterValueIn, String parameterPatternIn, int comparatorIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(Object parameterValueIn, String parameterPatternIn, int comparatorIn, MatchMode matchModeIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(Object parameterValueIn, String parameterPatternIn, MatchMode matchModeIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(String[] parameterValueIn, String parameterPatternIn) Constructor for CriteriaSearchParameter for a String[] parameter.
CriteriaSearchParameter(String[] parameterValueIn, String parameterPatternIn, boolean searchIfNull) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(String[] parameterValueIn, String parameterPatternIn, boolean searchIfNull, MatchMode matchModeIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(String[] parameterValueIn, String parameterPatternIn, MatchMode matchModeIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(String parameterValueIn, String parameterPatternIn) Constructor for CriteriaSearchParameter for a String parameter.
CriteriaSearchParameter(String parameterValueIn, String parameterPatternIn, boolean searchIfNull) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(String parameterValueIn, String parameterPatternIn, boolean searchIfNull, int comparatorIn, MatchMode matchModeIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(String parameterValueIn, String parameterPatternIn, boolean searchIfNull, MatchMode matchModeIn) Constructor for CriteriaSearchParameter.
CriteriaSearchParameter(String parameterValueIn, String parameterPatternIn, MatchMode matchModeIn) Constructor for CriteriaSearchParameter.

Method Summary

Methods

Modifier and Type	Method and Description
MatchMode	getMatchMode()
int	getOrderDirection()
int	getOrderRelevance()
String	getParameterName()
String	getParameterPattern()
Object	getParameterValue()
void	setMatchMode(MatchMode matchModeIn) Sets the hibernate matchmode of this parameter.
void	setOrderDirection(int orderDirectionIn) Sets the ordering for this parameter.
void	setOrderRelevance(int relevanceIn) Sets the ordering relevance for this parameter.
void	setParameterPattern(String parameterPatternIn) Sets the pattern of this parameter.
void	setParameterValue(Object parameterValueIn) Sets the value of this parameter.

Methods inherited from class SearchParameter

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

Methods inherited from class Object

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

Field Detail

PATTERN

public static final Pattern PATTERN

Compiled pattern \\.

RELEVANCE_UNSET

public static final int RELEVANCE_UNSET

Order relevance not set

See Also:

Constant Field Values

Constructor Detail

CriteriaSearchParameter

public CriteriaSearchParameter(Object parameterValueIn,
                       String parameterPatternIn)

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

Parameters:

parameterValueIn - The actual value of the parameter.

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

CriteriaSearchParameter

public CriteriaSearchParameter(String parameterValueIn,
                       String parameterPatternIn)

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

Parameters:

parameterValueIn - The actual value of the parameter.

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

CriteriaSearchParameter

public CriteriaSearchParameter(String[] parameterValueIn,
                       String parameterPatternIn)

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

Parameters:

parameterValueIn - The actual value of the parameter.

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

CriteriaSearchParameter

public CriteriaSearchParameter(Object parameterValueIn,
                       String parameterPatternIn,
                       int comparatorIn)

Constructor for CriteriaSearchParameter. Sets searchIfNull to false.

Parameters:

parameterValueIn - The actual value of the parameter.

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

comparatorIn -

CriteriaSearchParameter

public CriteriaSearchParameter(Object parameterValueIn,
                       String parameterPatternIn,
                       boolean searchIfNull)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(String parameterValueIn,
                       String parameterPatternIn,
                       boolean searchIfNull)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(String[] parameterValueIn,
                       String parameterPatternIn,
                       boolean searchIfNull)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(Object parameterValueIn,
                       String parameterPatternIn,
                       boolean searchIfNull,
                       int comparatorIn)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(Object parameterValueIn,
                       String parameterPatternIn,
                       boolean searchIfNull,
                       MatchMode matchModeIn)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(String parameterValueIn,
                       String parameterPatternIn,
                       boolean searchIfNull,
                       MatchMode matchModeIn)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(String[] parameterValueIn,
                       String parameterPatternIn,
                       boolean searchIfNull,
                       MatchMode matchModeIn)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(String parameterValueIn,
                       String parameterPatternIn,
                       boolean searchIfNull,
                       int comparatorIn,
                       MatchMode matchModeIn)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(Object parameterValueIn,
                       String parameterPatternIn,
                       int comparatorIn,
                       MatchMode matchModeIn)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(Object parameterValueIn,
                       String parameterPatternIn,
                       MatchMode matchModeIn)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(String parameterValueIn,
                       String parameterPatternIn,
                       MatchMode matchModeIn)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

CriteriaSearchParameter

public CriteriaSearchParameter(String[] parameterValueIn,
                       String parameterPatternIn,
                       MatchMode matchModeIn)

Constructor for CriteriaSearchParameter.

Parameters:

parameterValueIn - The actual value of the parameter.

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

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

Method Detail

getParameterPattern

public String getParameterPattern()

Returns:

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

setParameterPattern

public void setParameterPattern(String parameterPatternIn)

Sets the pattern of this parameter.

Parameters:

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

getParameterName

public String getParameterName()

Returns:

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

getParameterValue

public Object getParameterValue()

Returns:

The value of this parameter.

setParameterValue

public void setParameterValue(Object parameterValueIn)

Sets the value of this parameter.

Parameters:

parameterValueIn - The value of this parameter.

getMatchMode

public MatchMode getMatchMode()

Returns:

The hibernate matchmode of this parameter.

setMatchMode

public void setMatchMode(MatchMode matchModeIn)

Sets the hibernate matchmode of this parameter.

Parameters:

matchModeIn - The hibernate matchmode.

getOrderDirection

public int getOrderDirection()

Returns:

The order (ascending or descending) for this parameter.

See Also:

SearchParameter.ORDER_ASC, SearchParameter.ORDER_DESC, SearchParameter.ORDER_UNSET

setOrderDirection

public void setOrderDirection(int orderDirectionIn)

Sets the ordering for this parameter.

Parameters:

orderDirectionIn - The ordering for this parameter.

getOrderRelevance

public int getOrderRelevance()

Returns:

The relevance for this parameter.

See Also:

SearchParameter.ORDER_UNSET

setOrderRelevance

public void setOrderRelevance(int relevanceIn)

Sets the ordering relevance for this parameter.

Parameters:

relevanceIn - The ordering relevance for this parameter.