com.smartgwt.client.data
Class Criterion

java.lang.Object
  com.smartgwt.client.core.JsObject
      com.smartgwt.client.core.DataClass
          com.smartgwt.client.data.Criteria
              com.smartgwt.client.data.Criterion

Direct Known Subclasses:

AdvancedCriteria

public class Criterion
extends Criteria

An object representing a criterion to apply to a record.

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).

Field Summary

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

Criterion()

Criterion(Criterion c)

Criterion(JavaScriptObject jsObj)

Criterion(OperatorId operator)

Criterion(OperatorId operator, Criterion[] criterias)

Criterion(String fieldName, OperatorId operator)

Criterion(String fieldName, OperatorId operator, Boolean value)
Constructor for Criterion with fieldName, operator and value.

Criterion(String fieldName, OperatorId operator, Boolean[] value)

Criterion(String fieldName, OperatorId operator, Date value)
Constructor for Criterion with fieldName, operator and value.

Criterion(String fieldName, OperatorId operator, Date[] value)

Criterion(String fieldName, OperatorId operator, Date start, Date end)
Constructor for Criterion with fieldName, operator, start and end values.

Criterion(String fieldName, OperatorId operator, Float value)
Constructor for Criterion with fieldName, operator and value.

Criterion(String fieldName, OperatorId operator, Float[] value)

Criterion(String fieldName, OperatorId operator, Float start, Float end)
Constructor for Criterion with fieldName, operator, start and end values.

Criterion(String fieldName, OperatorId operator, Integer value)
Constructor for Criterion with fieldName, operator and value.

Criterion(String fieldName, OperatorId operator, Integer[] value)

Criterion(String fieldName, OperatorId operator, Integer start, Integer end)
Constructor for Criterion with fieldName, operator, start and end values.

Criterion(String fieldName, OperatorId operator, Long value)
Constructor for Criterion with fieldName, operator and value.

Criterion(String fieldName, OperatorId operator, Long[] value)

Criterion(String fieldName, OperatorId operator, Long start, Long end)
Constructor for Criterion with fieldName, operator, start and end values.

Criterion(String fieldName, OperatorId operator, String value)
Constructor for Criterion with fieldName, operator and value.

Criterion(String fieldName, OperatorId operator, String[] value)

Criterion(String fieldName, OperatorId operator, String start, String end)
Constructor for Criterion with fieldName, operator, start and end values.

Method Summary

void	addCriteria(Criterion c) Adds a new criteria.
void	addCriteria(String field, Boolean value)
void	addCriteria(String field, Boolean[] value)
void	addCriteria(String field, Date value)
void	addCriteria(String field, Date[] value)
void	addCriteria(String field, Float value)
void	addCriteria(String field, Float[] value)
void	addCriteria(String field, Integer value)
void	addCriteria(String field, Integer[] value)
void	addCriteria(String field, OperatorId op, Boolean value)
void	addCriteria(String field, OperatorId op, Boolean[] value)
void	addCriteria(String field, OperatorId op, Date value)
void	addCriteria(String field, OperatorId op, Date[] value)
void	addCriteria(String field, OperatorId op, Float value)
void	addCriteria(String field, OperatorId op, Float[] value)
void	addCriteria(String field, OperatorId op, Integer value)
void	addCriteria(String field, OperatorId op, Integer[] value)
void	addCriteria(String field, OperatorId op, String value)
void	addCriteria(String field, OperatorId op, String[] value)
void	addCriteria(String field, String value)
void	addCriteria(String field, String[] value)
void	appendToCriterionList(Criterion c)
void	buildCriterionFromList(OperatorId operator, Criterion[] criterias)
Criterion[]	getCriteria() Returns an array of sub-criteria for this criterion.
String	getFieldName() Name of the field in each Record that this criterion applies to.
OperatorId	getOperator() Operator this criterion applies.
static Criterion	getOrCreateRef(JavaScriptObject jsObj)
Boolean	getValueAsBoolean() Retrieves the specified value for this criterion.
Date	getValueAsDate() Retrieves the specified value for this criterion.
Float	getValueAsFloat() Retrieves the specified value for this criterion.
int[]	getValueAsIntArray() Retrieves the specified value for this criterion.
Integer	getValueAsInteger() Retrieves the specified value for this criterion.
String	getValueAsString() Retrieves the specified value for this criterion.
String[]	getValueAsStringArray() Retrieves the specified value for this criterion.
void	markAdvancedCriteria()
void	setFieldName(String fieldName) Name of the field in each Record that this criterion applies to.
void	setJavaScriptObject(JavaScriptObject jsObj)
void	setOperator(OperatorId operator) Operator this criterion applies.
void	unmarkAdvancedCriteria()

Methods inherited from class com.smartgwt.client.data.Criteria

addCriteria, addCriteria, addCriteria, asAdvancedCriteria, convertToCriteriaArray, getValues, isAdvanced

Methods inherited from class com.smartgwt.client.core.DataClass

doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class com.smartgwt.client.core.JsObject

isCreated, setJsObj

Methods inherited from class java.lang.Object

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

Constructor Detail

Criterion

public Criterion()

Criterion

public Criterion(JavaScriptObject jsObj)

Criterion

public Criterion(Criterion c)

Criterion

public Criterion(OperatorId operator,
                 Criterion[] criterias)

Criterion

public Criterion(OperatorId operator)

Criterion

public Criterion(String fieldName,
                 OperatorId operator)

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Integer value)

Constructor for Criterion with fieldName, operator and value.

Parameters:

fieldName - the field name

operator - the operator

value - the value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Integer start,
                 Integer end)

Constructor for Criterion with fieldName, operator, start and end values. This constructor is only valid when the operator is OperatorId.BETWEEN or OperatorId.BETWEEN_INCLUSIVE

Parameters:

fieldName - the field name

operator - the operator

start - the start value

end - the end value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 String value)

Constructor for Criterion with fieldName, operator and value.

Parameters:

fieldName - the field name

operator - the operator

value - the value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 String start,
                 String end)

Constructor for Criterion with fieldName, operator, start and end values. This constructor is only valid when the operator is OperatorId.BETWEEN or OperatorId.BETWEEN_INCLUSIVE

Parameters:

fieldName - the field name

operator - the operator

start - the start value

end - the end value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Float value)

Constructor for Criterion with fieldName, operator and value.

Parameters:

fieldName - the field name

operator - the operator

value - the value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Float start,
                 Float end)

Constructor for Criterion with fieldName, operator, start and end values. This constructor is only valid when the operator is OperatorId.BETWEEN or OperatorId.BETWEEN_INCLUSIVE

Parameters:

fieldName - the field name

operator - the operator

start - the start value

end - the end value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Date value)

Constructor for Criterion with fieldName, operator and value.

Parameters:

fieldName - the field name

operator - the operator

value - the value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Date start,
                 Date end)

Constructor for Criterion with fieldName, operator, start and end values. This constructor is only valid when the operator is OperatorId.BETWEEN or OperatorId.BETWEEN_INCLUSIVE

Parameters:

fieldName - the field name

operator - the operator

start - the start value

end - the end value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Boolean value)

Constructor for Criterion with fieldName, operator and value.

Parameters:

fieldName - the field name

operator - the operator

value - the value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Long value)

Constructor for Criterion with fieldName, operator and value. Note that JavaScript does not natively have an equivalent format to Java long (fixed point 64 bit). As such the value passed in will be converted to a double value for storage.

Parameters:

fieldName - the field name

operator - the operator

value - the value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Long start,
                 Long end)

Constructor for Criterion with fieldName, operator, start and end values. This constructor is only valid when the operator is OperatorId.BETWEEN or OperatorId.BETWEEN_INCLUSIVE

Parameters:

fieldName - the field name

operator - the operator

start - the start value

end - the end value

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Integer[] value)

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 String[] value)

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Float[] value)

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Long[] value)

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Date[] value)

Criterion

public Criterion(String fieldName,
                 OperatorId operator,
                 Boolean[] value)

Method Detail

getOrCreateRef

public static Criterion getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

setFieldName

public void setFieldName(String fieldName)

Name of the field in each 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.

Parameters:

fieldName - . See String. Default value is null

getFieldName

public String getFieldName()

Name of the field in each 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.

Returns:

. See String

setOperator

public void setOperator(OperatorId operator)

Operator this criterion applies.

Parameters:

operator - operator Default value is null

getOperator

public OperatorId getOperator()

Operator this criterion applies.

Returns:

OperatorId

addCriteria

public void addCriteria(Criterion c)

Adds a new criteria.

If the present criteria operation is "and", the new criteria is appended to the criteria list.

Otherwise, the present criteria is replaced with an "and" criteria, with two sub-criteria: the present criteria, and the passed criteria.

Parameters:

c - the passed criteria object

addCriteria

public void addCriteria(String field,
                        String value)

Overrides:

addCriteria in class Criteria

See Also:

addCriteria(Criterion)

addCriteria

public void addCriteria(String field,
                        Integer value)

Overrides:

addCriteria in class Criteria

addCriteria

public void addCriteria(String field,
                        Float value)

Overrides:

addCriteria in class Criteria

addCriteria

public void addCriteria(String field,
                        Date value)

Overrides:

addCriteria in class Criteria

addCriteria

public void addCriteria(String field,
                        Boolean value)

Overrides:

addCriteria in class Criteria

addCriteria

public void addCriteria(String field,
                        String[] value)

Overrides:

addCriteria in class Criteria

addCriteria

public void addCriteria(String field,
                        Integer[] value)

Overrides:

addCriteria in class Criteria

addCriteria

public void addCriteria(String field,
                        Float[] value)

addCriteria

public void addCriteria(String field,
                        Date[] value)

addCriteria

public void addCriteria(String field,
                        Boolean[] value)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        String value)

See Also:

addCriteria(Criterion)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        Integer value)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        Float value)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        Date value)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        Boolean value)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        String[] value)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        Integer[] value)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        Float[] value)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        Date[] value)

addCriteria

public void addCriteria(String field,
                        OperatorId op,
                        Boolean[] value)

buildCriterionFromList

public void buildCriterionFromList(OperatorId operator,
                                   Criterion[] criterias)

appendToCriterionList

public void appendToCriterionList(Criterion c)

markAdvancedCriteria

public void markAdvancedCriteria()

unmarkAdvancedCriteria

public void unmarkAdvancedCriteria()

getCriteria

public Criterion[] getCriteria()

Returns an array of sub-criteria for this criterion. Will return null if there are no sub criterion. Only applicable for criterion with operator type set to AND or OR.

Returns:

String

getValueAsString

public String getValueAsString()

Retrieves the specified value for this criterion. Only applies to criterion where operator and value have been specified - will not apply to criterion containing #getCriteria(),sub criteria.

Returns:

getValueAsInteger

public Integer getValueAsInteger()

Retrieves the specified value for this criterion. Only applies to criterion where operator and value have been specified - will not apply to criterion containing #getCriteria(),sub criteria.

Returns:

getValueAsFloat

public Float getValueAsFloat()

Retrieves the specified value for this criterion. Only applies to criterion where operator and value have been specified - will not apply to criterion containing #getCriteria(),sub criteria.

Returns:

getValueAsDate

public Date getValueAsDate()

Retrieves the specified value for this criterion. Only applies to criterion where operator and value have been specified - will not apply to criterion containing #getCriteria(),sub criteria.

Returns:

getValueAsBoolean

public Boolean getValueAsBoolean()

Retrieves the specified value for this criterion. Only applies to criterion where operator and value have been specified - will not apply to criterion containing #getCriteria(),sub criteria.

Returns:

getValueAsStringArray

public String[] getValueAsStringArray()

Retrieves the specified value for this criterion. Only applies to criterion where operator and value have been specified - will not apply to criterion containing #getCriteria(),sub criteria.

Returns:

getValueAsIntArray

public int[] getValueAsIntArray()

Retrieves the specified value for this criterion. Only applies to criterion where operator and value have been specified - will not apply to criterion containing #getCriteria(),sub criteria.

Returns: