|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchCriteria
@JsonObject(value="SearchCriteria") public class SearchCriteria
A (mutable) object representing the specification of a search. A search is specified by MatchClause objects and an operator for combining match clauses. Additionally sub criteria can be added for entities connected with the main entity object.
A MatchClause is made up of a property or attribute to compare against and a desired value for that property or attribute.
Example:
Match all of the following clauses:
- Attribute('TYPE') = [desired value]
- Property('PROPERTY_CODE') = [desired value]
Looks like this:
SearchCriteria sc = new SearchCriteria();
sc.addMatchClause(MatchClause.createAttributeMatch(MatchClauseAttribute.TYPE, "A_TYPE_CODE"));
sc.addMatchClause(MatchClause.createPropertyMatch("PROPERTY_CODE", "a property value"));
Extension of the previous example with with experiment criteria:
SearchCriteria ec = new SearchCriteria();
ec.addMatchClause(MatchClause.createAttributeMatch(MatchClauseAttribute.CODE, "EXP_CODE"));
sc.addSubCriteria(SearchSubCriteria.createExperimentCriteria(ec));
For other sub criteria types see SearchSubCriteria
.
SearchSubCriteria
,
Serialized FormNested Class Summary | |
---|---|
static class |
SearchCriteria.AnyFieldMatchClause
A MatchClause for checking that any of the properties or attributes equals a desired value. |
static class |
SearchCriteria.AnyPropertyMatchClause
A MatchClause for checking that any of the properties equals a desired value. |
static class |
SearchCriteria.AttributeMatchClause
A MatchClause for checking that an attribute equals a desired value. |
static class |
SearchCriteria.CompareMode
|
static class |
SearchCriteria.MatchClause
A specification of one field (either property or attribute) and desired value for that field. |
static class |
SearchCriteria.MatchClauseAttribute
An enum listing the different attributes that can be compared against. |
static class |
SearchCriteria.MatchClauseFieldType
An enum listing the different field types that can be compared against. |
static class |
SearchCriteria.MatchClauseTimeAttribute
An enum listing the different attributes containing time values that can be compared against. |
static class |
SearchCriteria.PropertyMatchClause
A MatchClause for checking that a property equals a desired value. |
static class |
SearchCriteria.SearchOperator
Operators for combining MatchClause objects. |
static class |
SearchCriteria.TimeAttributeMatchClause
A MatchClause for comparing a time attribute to a specified value. |
Constructor Summary | |
---|---|
SearchCriteria()
|
Method Summary | |
---|---|
void |
addMatchClause(SearchCriteria.MatchClause criterion)
Add a new match clause. |
void |
addSubCriteria(SearchSubCriteria criteria)
Add a new sub search criteria. |
boolean |
equals(java.lang.Object obj)
|
java.util.List<SearchCriteria.MatchClause> |
getMatchClauses()
Get a list of MatchClause objects this SearchCriteria will match against. |
SearchCriteria.SearchOperator |
getOperator()
Gets the operator for combining MatchClause objects. |
java.util.List<SearchSubCriteria> |
getSubCriterias()
Get a list of SearchSubCriteria objects for this SearchCriteria. |
int |
hashCode()
|
void |
setOperator(SearchCriteria.SearchOperator operator)
Set the operator for combining MatchClause objects. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SearchCriteria()
Method Detail |
---|
public void setOperator(SearchCriteria.SearchOperator operator)
public SearchCriteria.SearchOperator getOperator()
SearchCriteria.SearchOperator
.MATCH_ALL_CRITERIA.
public java.util.List<SearchCriteria.MatchClause> getMatchClauses()
public void addMatchClause(SearchCriteria.MatchClause criterion)
public java.util.List<SearchSubCriteria> getSubCriterias()
SearchSubCriteria
objects for this SearchCriteria.
public void addSubCriteria(SearchSubCriteria criteria)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |