public class Criterion extends Criteria
A criterion is part of the definition of an AdvancedCriteria
object, which is used to filter records according to search criteria.
A
criterion consists of an operator
and typically a fieldName
from a Record
and a value
to compare to. However some operators either don't require a value
(eg, isNull) or act on other criteria rather than directly on a Record
's fields (eg,
the "and" and "or" logical operators).
A shortcut form is also allowed where only fieldName
and
value
values are provided. In this case the operator
is assumed to be "equals".
factoryCreated, factoryProperties
Constructor and Description |
---|
Criterion() |
Criterion(Criterion c) |
Criterion(Criterion[] criterias) |
Criterion(com.google.gwt.core.client.JavaScriptObject jsObj) |
Criterion(OperatorId operator) |
Criterion(OperatorId operator,
Criterion[] criterias) |
Criterion(java.lang.String fieldName) |
Criterion(java.lang.String fieldName,
OperatorId operator) |
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Boolean value)
Constructor for Criterion with fieldName, operator and value.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Boolean[] value) |
Criterion(java.lang.String fieldName,
OperatorId operator,
java.util.Date value)
Constructor for Criterion with fieldName, operator and value.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.util.Date[] value) |
Criterion(java.lang.String fieldName,
OperatorId operator,
java.util.Date start,
java.util.Date end)
Constructor for Criterion with fieldName, operator, start and end values.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Float value)
Constructor for Criterion with fieldName, operator and value.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Float[] value) |
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Float start,
java.lang.Float end)
Constructor for Criterion with fieldName, operator, start and end values.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Integer value)
Constructor for Criterion with fieldName, operator and value.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Integer[] value) |
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Integer start,
java.lang.Integer end)
Constructor for Criterion with fieldName, operator, start and end values.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Long value)
Constructor for Criterion with fieldName, operator and value.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Long[] value) |
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.Long start,
java.lang.Long end)
Constructor for Criterion with fieldName, operator, start and end values.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
RelativeDate value)
Constructor for Criterion with fieldName, operator and RelativeDate value.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
RelativeDate start,
RelativeDate end)
Constructor for Criterion with fieldName, operator, start and end RelativeDate values.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.String value)
Constructor for Criterion with fieldName, operator and value.
|
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.String[] value) |
Criterion(java.lang.String fieldName,
OperatorId operator,
java.lang.String start,
java.lang.String end)
Constructor for Criterion with fieldName, operator, start and end values.
|
Modifier and Type | Method and Description |
---|---|
void |
addCriteria(Criteria c)
Adds a new criteria.
|
void |
addCriteria(Criterion c)
Adds a new criteria.
|
void |
addCriteria(java.lang.String field)
This method calls
#addCriteria(String, OperatorId, value) , passing "EQUALS" as the OperatorId and
Boolean.TRUE as value. |
void |
addCriteria(java.lang.String field,
java.lang.Boolean value)
This method is similar to
addCriteria(String, String) . |
void |
addCriteria(java.lang.String field,
java.lang.Boolean[] value)
This method is similar to
addCriteria(String, String) . |
void |
addCriteria(java.lang.String field,
java.util.Date value)
This method is similar to
addCriteria(String, String) . |
void |
addCriteria(java.lang.String field,
java.util.Date[] value)
This method is similar to
addCriteria(String, String) . |
void |
addCriteria(java.lang.String field,
java.lang.Float value)
This method is similar to
addCriteria(String, String) . |
void |
addCriteria(java.lang.String field,
java.lang.Float[] value)
This method is similar to
addCriteria(String, String) . |
void |
addCriteria(java.lang.String field,
java.lang.Integer value)
This method is similar to
addCriteria(String, String) . |
void |
addCriteria(java.lang.String field,
java.lang.Integer[] value)
This method is similar to
addCriteria(String, String) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.lang.Boolean value)
This method is similar to
addCriteria(String, OperatorId, String) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.lang.Boolean[] value)
This method is similar to
addCriteria(String, OperatorId, String) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.util.Date value)
This method is similar to
addCriteria(String, OperatorId, String) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.util.Date[] value)
This method is similar to
addCriteria(String, OperatorId, String) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.lang.Float value)
This method is similar to
addCriteria(String, OperatorId, String) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.lang.Float[] value)
This method is similar to
addCriteria(String, OperatorId, String) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.lang.Integer value)
This method is similar to
addCriteria(String, OperatorId, String) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.lang.Integer[] value)
This method is similar to
addCriteria(String, OperatorId, String) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.lang.String value)
Creates a Criterion and calls
addCriteria(Criterion) . |
void |
addCriteria(java.lang.String field,
OperatorId op,
java.lang.String[] value)
This method is similar to
addCriteria(String, OperatorId, String) . |
void |
addCriteria(java.lang.String field,
java.lang.String value)
This method calls
addCriteria(String, OperatorId, String) , passing "EQUALS" as the OperatorId. |
void |
addCriteria(java.lang.String field,
java.lang.String[] value)
This method is similar to
addCriteria(String, String) . |
void |
appendToCriterionList(Criterion c)
For a Criterion that uses
OperatorId.AND or OperatorId.OR , add an
additional Criterion to the list of subcriteria to be evaluated. |
AdvancedCriteria |
asAdvancedCriteria()
Returns an AdvancedCriteria derived from this Criteria object.
|
void |
buildCriterionFromList(OperatorId operator,
Criterion[] criterias) |
Criterion[] |
getCriteria()
For a criterion with an operator that acts on other criteria (eg "and", "or"), a list of sub-criteria that are grouped
together by the operator.
|
java.lang.String |
getFieldName()
Name of the field in each
Record that this criterion applies to. |
OperatorId |
getOperator()
Operator this criterion applies.
|
static Criterion |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.Boolean |
getValueAsBoolean()
Retrieves the specified value for this criterion.
|
java.util.Date |
getValueAsDate()
Retrieves the specified value for this criterion.
|
java.lang.Float |
getValueAsFloat()
Retrieves the specified value for this criterion.
|
java.lang.Integer |
getValueAsInt()
Synonym of
getValueAsInteger() . |
int[] |
getValueAsIntArray()
Retrieves the specified value for this criterion.
|
java.lang.Integer |
getValueAsInteger()
Retrieves the specified value for this criterion.
|
java.lang.String |
getValueAsString()
Retrieves the specified value for this criterion.
|
java.lang.String[] |
getValueAsStringArray()
Retrieves the specified value for this criterion.
|
java.lang.String |
getValuePath()
Wherever
DynamicCriteria are supported, valuePath can be specified as a
path in the current Canvas.ruleScope as an alternative to
setting a fixed value . |
static boolean |
instanceOf(java.lang.Object object) |
void |
markAdvancedCriteria() |
Criterion |
setCriteria(Criterion... criteria)
For a criterion with an operator that acts on other criteria (eg "and", "or"), a list of sub-criteria that are grouped
together by the operator.
|
void |
setCustomOperator(java.lang.String operator)
Specifies a "custom" operator to this criterion.
|
Criterion |
setFieldName(java.lang.String fieldName)
Name of the field in each
Record that this criterion applies to. |
Criterion |
setOperator(OperatorId operator)
Operator this criterion applies.
|
Criterion |
setValuePath(java.lang.String valuePath)
Wherever
DynamicCriteria are supported, valuePath can be specified as a
path in the current Canvas.ruleScope as an alternative to
setting a fixed value . |
void |
unmarkAdvancedCriteria() |
addCriteria, addCriteria, addCriteria, addCriteria, addCriteria, convertToCriteriaArray, getValues, isAdvanced
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
public Criterion()
public Criterion(com.google.gwt.core.client.JavaScriptObject jsObj)
public Criterion(Criterion c)
public Criterion(Criterion[] criterias)
public Criterion(OperatorId operator, Criterion[] criterias)
public Criterion(OperatorId operator)
public Criterion(java.lang.String fieldName)
public Criterion(java.lang.String fieldName, OperatorId operator)
public Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Integer value)
fieldName
- the field nameoperator
- the operatorvalue
- the valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Integer start, java.lang.Integer end)
OperatorId.BETWEEN
or OperatorId.BETWEEN_INCLUSIVE
fieldName
- the field nameoperator
- the operatorstart
- the start valueend
- the end valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.lang.String value)
fieldName
- the field nameoperator
- the operatorvalue
- the valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.lang.String start, java.lang.String end)
OperatorId.BETWEEN
or OperatorId.BETWEEN_INCLUSIVE
fieldName
- the field nameoperator
- the operatorstart
- the start valueend
- the end valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Float value)
fieldName
- the field nameoperator
- the operatorvalue
- the valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Float start, java.lang.Float end)
OperatorId.BETWEEN
or OperatorId.BETWEEN_INCLUSIVE
fieldName
- the field nameoperator
- the operatorstart
- the start valueend
- the end valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.util.Date value)
fieldName
- the field nameoperator
- the operatorvalue
- the valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.util.Date start, java.util.Date end)
OperatorId.BETWEEN
or OperatorId.BETWEEN_INCLUSIVE
fieldName
- the field nameoperator
- the operatorstart
- the start valueend
- the end valuepublic Criterion(java.lang.String fieldName, OperatorId operator, RelativeDate value)
fieldName
- the field nameoperator
- the operatorvalue
- the RelativeDate valuepublic Criterion(java.lang.String fieldName, OperatorId operator, RelativeDate start, RelativeDate end)
OperatorId.BETWEEN
or OperatorId.BETWEEN_INCLUSIVE
fieldName
- the field nameoperator
- the operatorstart
- the start valueend
- the end valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Boolean value)
fieldName
- the field nameoperator
- the operatorvalue
- the valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Long value)
fieldName
- the field nameoperator
- the operatorvalue
- the valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Long start, java.lang.Long end)
OperatorId.BETWEEN
or OperatorId.BETWEEN_INCLUSIVE
fieldName
- the field nameoperator
- the operatorstart
- the start valueend
- the end valuepublic Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Integer[] value)
public Criterion(java.lang.String fieldName, OperatorId operator, java.lang.String[] value)
public Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Float[] value)
public Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Long[] value)
public Criterion(java.lang.String fieldName, OperatorId operator, java.util.Date[] value)
public Criterion(java.lang.String fieldName, OperatorId operator, java.lang.Boolean[] value)
public static Criterion getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public Criterion setCriteria(Criterion... criteria)
criteria
- New criteria value. Default value is nullCriterion
instance, for chaining setter callsAdvancedFilter overview and related methods
public Criterion[] getCriteria()
AdvancedFilter overview and related methods
public Criterion setFieldName(java.lang.String fieldName)
Record
that this criterion applies to. Not applicable for a
criterion with sub-criteria
. Can be specified as a dataPath to
allow matching nested objects. Use '/' as delimiters for dataPath. See dataPath
for more information.fieldName
- New fieldName value. Default value is nullCriterion
instance, for chaining setter callsAdvancedFilter overview and related methods
public java.lang.String getFieldName()
Record
that this criterion applies to. Not applicable for a
criterion with sub-criteria
. Can be specified as a dataPath to
allow matching nested objects. Use '/' as delimiters for dataPath. See dataPath
for more information.AdvancedFilter overview and related methods
public Criterion setOperator(OperatorId operator)
operator
- New operator value. Default value is nullCriterion
instance, for chaining setter callsAdvancedFilter overview and related methods
public OperatorId getOperator()
AdvancedFilter overview and related methods
public Criterion setValuePath(java.lang.String valuePath)
DynamicCriteria
are supported, valuePath
can be specified as a
path in the current Canvas.ruleScope
as an alternative to
setting a fixed value
. Note: valuePath
vs setting a
path for fieldName
:
criterion.fieldName
when criteria will be matched against a nested data structure. criterion.valuePath
when the values used in filtering should be dynamically derived based on the
Canvas.ruleScope
. This does not imply that the criteria
will be matched against a nested structure. valuePath
- New valuePath value. Default value is nullCriterion
instance, for chaining setter callspublic java.lang.String getValuePath()
DynamicCriteria
are supported, valuePath
can be specified as a
path in the current Canvas.ruleScope
as an alternative to
setting a fixed value
. Note: valuePath
vs setting a
path for fieldName
:
criterion.fieldName
when criteria will be matched against a nested data structure. criterion.valuePath
when the values used in filtering should be dynamically derived based on the
Canvas.ruleScope
. This does not imply that the criteria
will be matched against a nested structure. public static final boolean instanceOf(java.lang.Object object)
public void addCriteria(Criterion c)
If the present criteria operation is "and", the new criteria is appended to the criteria list.
Otherwise, the existing criteria is replaced with an "and" criteria, with two sub-criteria: the existing criteria, and the passed criteria.
Note that if the existing criteria was empty (as would happen if new AdvancedCriteria() were called with no arguments), an "and" operator will still be introduced, but the passed criteria will be the only sub-criteria.
To add an additional Criterion when using the "or" operator, use
appendToCriterionList(com.smartgwt.client.data.Criterion)
.
c
- the passed criteria objectpublic void addCriteria(Criteria c)
addCriteria
in class Criteria
c
- the passed criteria objectpublic void addCriteria(java.lang.String field)
#addCriteria(String, OperatorId, value)
, passing "EQUALS" as the OperatorId and
Boolean.TRUE as value.addCriteria(Criterion)
public void addCriteria(java.lang.String field, java.lang.String value)
addCriteria(String, OperatorId, String)
, passing "EQUALS" as the OperatorId.addCriteria
in class Criteria
addCriteria(Criterion)
public void addCriteria(java.lang.String field, java.lang.Integer value)
addCriteria(String, String)
.addCriteria
in class Criteria
public void addCriteria(java.lang.String field, java.lang.Float value)
addCriteria(String, String)
.addCriteria
in class Criteria
public void addCriteria(java.lang.String field, java.util.Date value)
addCriteria(String, String)
.addCriteria
in class Criteria
public void addCriteria(java.lang.String field, java.lang.Boolean value)
addCriteria(String, String)
.addCriteria
in class Criteria
public void addCriteria(java.lang.String field, java.lang.String[] value)
addCriteria(String, String)
.addCriteria
in class Criteria
public void addCriteria(java.lang.String field, java.lang.Integer[] value)
addCriteria(String, String)
.addCriteria
in class Criteria
public void addCriteria(java.lang.String field, java.lang.Float[] value)
addCriteria(String, String)
.addCriteria
in class Criteria
public void addCriteria(java.lang.String field, java.util.Date[] value)
addCriteria(String, String)
.public void addCriteria(java.lang.String field, java.lang.Boolean[] value)
addCriteria(String, String)
.addCriteria
in class Criteria
public void addCriteria(java.lang.String field, OperatorId op, java.lang.String value)
addCriteria(Criterion)
.public void addCriteria(java.lang.String field, OperatorId op, java.lang.Integer value)
addCriteria(String, OperatorId, String)
.public void addCriteria(java.lang.String field, OperatorId op, java.lang.Float value)
addCriteria(String, OperatorId, String)
.public void addCriteria(java.lang.String field, OperatorId op, java.util.Date value)
addCriteria(String, OperatorId, String)
.public void addCriteria(java.lang.String field, OperatorId op, java.lang.Boolean value)
addCriteria(String, OperatorId, String)
.public void addCriteria(java.lang.String field, OperatorId op, java.lang.String[] value)
addCriteria(String, OperatorId, String)
.public void addCriteria(java.lang.String field, OperatorId op, java.lang.Integer[] value)
addCriteria(String, OperatorId, String)
.public void addCriteria(java.lang.String field, OperatorId op, java.lang.Float[] value)
addCriteria(String, OperatorId, String)
.public void addCriteria(java.lang.String field, OperatorId op, java.util.Date[] value)
addCriteria(String, OperatorId, String)
.public void addCriteria(java.lang.String field, OperatorId op, java.lang.Boolean[] value)
addCriteria(String, OperatorId, String)
.public void buildCriterionFromList(OperatorId operator, Criterion[] criterias)
public void appendToCriterionList(Criterion c)
OperatorId.AND
or OperatorId.OR
, add an
additional Criterion to the list of subcriteria to be evaluated.public void setCustomOperator(java.lang.String operator)
operator
- the operatorpublic void markAdvancedCriteria()
public void unmarkAdvancedCriteria()
public java.lang.String getValueAsString()
#getCriteria(),sub criteria
.public final java.lang.Integer getValueAsInt()
getValueAsInteger()
.public java.lang.Integer getValueAsInteger()
#getCriteria(),sub criteria
.public java.lang.Float getValueAsFloat()
#getCriteria(),sub criteria
.public java.util.Date getValueAsDate()
#getCriteria(),sub criteria
.public java.lang.Boolean getValueAsBoolean()
#getCriteria(),sub criteria
.public java.lang.String[] getValueAsStringArray()
#getCriteria(),sub criteria
.public int[] getValueAsIntArray()
#getCriteria(),sub criteria
.public AdvancedCriteria asAdvancedCriteria()
asAdvancedCriteria
in class Criteria