Package com.soffid.iam.model.criteria
Class CriteriaSearchParameter
- java.lang.Object
-
- com.soffid.iam.model.criteria.CriteriaSearchParameter
-
public class CriteriaSearchParameter extends Object
ACriteriaSearchParameter
represents a parameter for aCriteriaSearch
.
TheparameterValue
is the actual value to be searched for.
TheparameterPattern
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 actualCriteriaSearch
. The pattern of a the street of an address of a person would look like address.street (assuming the entity structure to beaPerson.getAddress().getStreet()
).
Usually, if a parameter isnull
(or if the parameter is of typeString
and empty), it is not considered for a search. IfsearchIfIsNull
istrue
it is explicitly searched for the parameter to be null (or empty if the parameter is of typeString
).
ThecomparatorID
defines the comparator for the parameter. For parameters of typeString
the default comparator is theLIKE_COMPARATOR
. TheEQUAL_COMPARATOR
is default for other parameters.
-
-
Field Summary
Fields Modifier and Type Field Description static int
EQUAL_COMPARATOR
static int
GREATER_THAN_COMPARATOR
static int
GREATER_THAN_OR_EQUAL_COMPARATOR
static int
IN_COMPARATOR
static int
INSENSITIVE_LIKE_COMPARATOR
static int
LESS_THAN_COMPARATOR
static int
LESS_THAN_OR_EQUAL_COMPARATOR
static int
LIKE_COMPARATOR
static int
NOT_EQUAL_COMPARATOR
static int
ORDER_ASC
Ascending orderstatic int
ORDER_DESC
Descending orderstatic int
ORDER_UNSET
Order unsetstatic Pattern
PATTERN
static int
RELEVANCE_UNSET
Order relevance not set
-
Constructor Summary
Constructors Constructor Description CriteriaSearchParameter(Object parameterValue, String parameterPattern)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(Object parameterValue, String parameterPattern, boolean searchIfnull)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(Object parameterValue, String parameterPattern, boolean searchIfnull, int comparatorID)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(Object parameterValue, String parameterPattern, boolean searchIfnull, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(Object parameterValue, String parameterPattern, int comparatorID)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(Object parameterValue, String parameterPattern, int comparatorID, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(Object parameterValue, String parameterPattern, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(String[] parameterValue, String parameterPattern)
Constructor for CriteriaSearchParameter for aString[]
parameter.CriteriaSearchParameter(String[] parameterValue, String parameterPattern, boolean searchIfnull)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(String[] parameterValue, String parameterPattern, boolean searchIfnull, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(String[] parameterValue, String parameterPattern, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(String parameterValue, String parameterPattern)
Constructor for CriteriaSearchParameter for aString
parameter.CriteriaSearchParameter(String parameterValue, String parameterPattern, boolean searchIfnull)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(String parameterValue, String parameterPattern, boolean searchIfnull, int comparatorID, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(String parameterValue, String parameterPattern, boolean searchIfnull, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.CriteriaSearchParameter(String parameterValue, String parameterPattern, org.hibernate.criterion.MatchMode matchMode)
Constructor for CriteriaSearchParameter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getComparatorID()
org.hibernate.criterion.MatchMode
getMatchMode()
int
getOrderDirection()
int
getOrderRelevance()
String
getParameterName()
String
getParameterPattern()
Object
getParameterValue()
boolean
isSearchIfIsNull()
void
setComparatorID(int comparatorID)
Sets the comparator to be used (e.g.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(String parameterPattern)
Sets the pattern of this parameter.void
setParameterValue(Object parameterValue)
Sets the value of this parameter.void
setSearchIfIsNull(boolean searchIfnull)
Defines whether parameter will be included in the search even if it isnull
.
-
-
-
Field Detail
-
PATTERN
public static final Pattern PATTERN
-
LIKE_COMPARATOR
public static final int LIKE_COMPARATOR
- See Also:
- Constant Field Values
-
INSENSITIVE_LIKE_COMPARATOR
public static final int INSENSITIVE_LIKE_COMPARATOR
- See Also:
- Constant Field Values
-
EQUAL_COMPARATOR
public static final int EQUAL_COMPARATOR
- See Also:
- Constant Field Values
-
GREATER_THAN_OR_EQUAL_COMPARATOR
public static final int GREATER_THAN_OR_EQUAL_COMPARATOR
- See Also:
- Constant Field Values
-
GREATER_THAN_COMPARATOR
public static final int GREATER_THAN_COMPARATOR
- See Also:
- Constant Field Values
-
LESS_THAN_OR_EQUAL_COMPARATOR
public static final int LESS_THAN_OR_EQUAL_COMPARATOR
- See Also:
- Constant Field Values
-
LESS_THAN_COMPARATOR
public static final int LESS_THAN_COMPARATOR
- See Also:
- Constant Field Values
-
IN_COMPARATOR
public static final int IN_COMPARATOR
- See Also:
- Constant Field Values
-
NOT_EQUAL_COMPARATOR
public static final int NOT_EQUAL_COMPARATOR
- See Also:
- Constant Field Values
-
ORDER_UNSET
public static final int ORDER_UNSET
Order unset- See Also:
- Constant Field Values
-
ORDER_ASC
public static final int ORDER_ASC
Ascending order- See Also:
- Constant Field Values
-
ORDER_DESC
public static final int ORDER_DESC
Descending order- See Also:
- Constant Field Values
-
RELEVANCE_UNSET
public static final int RELEVANCE_UNSET
Order relevance not set- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CriteriaSearchParameter
public CriteriaSearchParameter(Object parameterValue, String parameterPattern)
Constructor for CriteriaSearchParameter. SetssearchIfIsNull
tofalse
and uses theEQUAL_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(String parameterValue, String parameterPattern)
Constructor for CriteriaSearchParameter for aString
parameter. SetssearchIfIsNull
tofalse
and uses theLIKE_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(String[] parameterValue, String parameterPattern)
Constructor for CriteriaSearchParameter for aString[]
parameter. SetssearchIfIsNull
tofalse
and uses theLIKE_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(Object parameterValue, String parameterPattern, int comparatorID)
Constructor for CriteriaSearchParameter. SetssearchIfIsNull
tofalse
.- 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(Object parameterValue, 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).searchIfIsNull
- Indicates whether the query should contain anIS null
if the parameter isnull
.
-
CriteriaSearchParameter
public CriteriaSearchParameter(String parameterValue, 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).searchIfIsNull
- Indicates whether the query should contain anIS null
if the parameter isnull
.
-
CriteriaSearchParameter
public CriteriaSearchParameter(String[] parameterValue, 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).searchIfIsNull
- Indicates whether the query should contain anIS null
if the parameter isnull
.
-
CriteriaSearchParameter
public CriteriaSearchParameter(Object parameterValue, String parameterPattern, boolean searchIfnull, int comparatorID)
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).searchIfIsNull
- Indicates whether the query should contain anIS null
if the parameter isnull
.comparatorID
- Indicates what comparator is to be used (e.g. like, =, <, ...).
-
CriteriaSearchParameter
public CriteriaSearchParameter(Object parameterValue, 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).searchIfIsNull
- Indicates whether the query should contain anIS null
if the parameter isnull
.matchMode
- The hibernate matchmode to be used in string comparisons.
-
CriteriaSearchParameter
public CriteriaSearchParameter(String parameterValue, 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).searchIfIsNull
- Indicates whether the query should contain anIS null
if the parameter isnull
.matchMode
- The hibernate matchmode to be used in string comparisons.
-
CriteriaSearchParameter
public CriteriaSearchParameter(String[] parameterValue, 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).searchIfIsNull
- Indicates whether the query should contain anIS null
if the parameter isnull
.matchMode
- The hibernate matchmode to be used in string comparisons.
-
CriteriaSearchParameter
public CriteriaSearchParameter(String parameterValue, String parameterPattern, boolean searchIfnull, int comparatorID, 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).searchIfIsNull
- Indicates whether the query should contain anIS null
if the parameter isnull
.comparatorID
- Indicates what comparator is to be used (e.g. like, =, <, ...).matchMode
- The hibernate matchmode to be used in string comparisons.
-
CriteriaSearchParameter
public CriteriaSearchParameter(Object parameterValue, String parameterPattern, int comparatorID, 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).comparatorID
- Indicates what comparator is to be used (e.g. like, =, <, ...).matchMode
- The hibernate matchmode to be used in string comparisons.
-
CriteriaSearchParameter
public CriteriaSearchParameter(Object parameterValue, 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(String parameterValue, 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(String[] parameterValue, 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
-
getComparatorID
public int getComparatorID()
- Returns:
- The comparator to be used (e.g. like, =, <, ...).
-
setComparatorID
public void setComparatorID(int comparatorID)
Sets the comparator to be used (e.g. like, =, <, ...).- Parameters:
comparatorID
- The comprator ID.
-
getParameterPattern
public String getParameterPattern()
- Returns:
- The pattern of this parameter (dot-seperated path e.g. person.address.street).
-
setParameterPattern
public void setParameterPattern(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 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 parameterValue)
Sets the value of this parameter.- Parameters:
parameterValue
- The value of this parameter.
-
isSearchIfIsNull
public boolean isSearchIfIsNull()
- Returns:
- Whether this parameter will be included in the search even if it is
null
.
-
setSearchIfIsNull
public void setSearchIfIsNull(boolean searchIfnull)
Defines whether parameter will be included in the search even if it isnull
.- Parameters:
searchIfnull
-true
if the parameter should be included in the search even if it is null,false
otherwise.
-
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.
-
-