Classes


Class actuate.data.Filter

The Filter class is used to specify a filter condition.
Member of: actuate.data.

Class Summary
Constructor Attributes Constructor Name and Description
 
actuate.data.Filter(columnName, operator, value1, value2)
The Filter class is used to specify a filter condition.
Field Summary
Field Attributes Field Name and Description
<static> <constant>  
Filter operator for "between".
<static> <constant>  
Filter operator for "bottom N".
<static> <constant>  
Filter operator for "bottom percent".
<static> <constant>  
EQ
Filter operator for "equals" Expression: "value1 = value2"
<static> <constant>  
Filter operator for "is false".
<static> <constant>  
Filter operator for "greater than" Expression: "value1 > value2"
<static> <constant>  
Filter operator for "greater than or equal" Expression: "value1 >= value2"
<static> <constant>  
IN
Filter operator for "in".
<static> <constant>  
Filter operator for "less than" Expression: "value1 < value2"
<static> <constant>  
Filter operator for "less than or equal" Expression: "value1 <= value2"
<static> <constant>  
Filter operator for "is like".
<static> <constant>  
Filter operator for "match".
<static> <constant>  
Filter operator "none".
<static> <constant>  
Filter operator for "between".
<static> <constant>  
Filter operator for "not equals" Expression: "value1 != value2" (value1 is different from value2) Needs two values.
<static> <constant>  
Filter operator for "not in".
<static> <constant>  
Filter operator for "not like".
<static> <constant>  
Filter operator for "not match".
<static> <constant>  
Filter operator for "is not null".
<static> <constant>  
Filter operator for "is null".
<static> <constant>  
Filter operator for "top N".
<static> <constant>  
Filter operator for "top percent".
<static> <constant>  
Filter operator for "is true".
Method Summary
Method Attributes Method Name and Description
 
Returns the column name.
 
Returns the operator.
 
Return string values.
 
setColumnName(columnName)
Sets the column name.
 
setOperator(operator)
Sets the operator.
 
setValues(value1, value2)
Set string values for the filter, according to the operator.
Class Detail
actuate.data.Filter(columnName, operator, value1, value2)
The Filter class is used to specify a filter condition. The condition is expressed as "value1 operator value2". For some operators, like "IN", the expression will be "value1 IN value2" where value2 is an array of strings.
Numbers and date/time values must be given in a locale neutral format, for example "2.5" or "09/31/2008 01:02:03 AM"
Parameters:
{String} columnName
column name
{String} operator
operator
{String} value1
string or array
{String} value2
string or array
Field Detail
<static> <constant> BETWEEN
Filter operator for "between". Expression: "value1 between value2[0] and value2[1]" where value2 is an array of strings.

<static> <constant> BOTTOM_N
Filter operator for "bottom N". Expression: "bottom n of value1"

<static> <constant> BOTTOM_PERCENT
Filter operator for "bottom percent". Expression: "bottom percent of value1"

<static> <constant> EQ
Filter operator for "equals" Expression: "value1 = value2"

<static> <constant> FALSE
Filter operator for "is false". Expression: "value1 is false"

<static> <constant> GREATER_THAN
Filter operator for "greater than" Expression: "value1 > value2"

<static> <constant> GREATER_THAN_OR_EQUAL
Filter operator for "greater than or equal" Expression: "value1 >= value2"

<static> <constant> IN
Filter operator for "in". Expression: "value1 in value2" where value2 is an array of strings.

<static> <constant> {String}} LESS_THAN
Filter operator for "less than" Expression: "value1 < value2"

<static> <constant> LESS_THAN_OR_EQUAL
Filter operator for "less than or equal" Expression: "value1 <= value2"

<static> <constant> LIKE
Filter operator for "is like". Expression: "value1 like value2"

<static> <constant> MATCH
Filter operator for "match". Expression: "value1 matches value2"

<static> <constant> NONE
Filter operator "none".

<static> <constant> NOT_BETWEEN
Filter operator for "between". Expression: "value1 not between value2[0] and value2[1]" where value2 is an array of strings.

<static> <constant> NOT_EQ
Filter operator for "not equals" Expression: "value1 != value2" (value1 is different from value2) Needs two values.

<static> <constant> NOT_IN
Filter operator for "not in". Expression: "value1 not in value2" where value2 is an array of strings.

<static> <constant> NOT_LIKE
Filter operator for "not like". Expression: "value1 not like value2"

<static> <constant> NOT_MATCH
Filter operator for "not match". Expression: "value1 doesn't match value2"

<static> <constant> NOT_NULL
Filter operator for "is not null". Expression: "value1 is not null"

<static> <constant> NULL
Filter operator for "is null". Expression: "value1 is null"

<static> <constant> TOP_N
Filter operator for "top N". Expression: "top n of value1"

<static> <constant> TOP_PERCENT
Filter operator for "top percent". Expression: "top percent of value1"

<static> <constant> TRUE
Filter operator for "is true". Expression: "value1 is true"
Method Detail
{String} getColumnName()
Returns the column name.
Returns:
{String} columnName

{String} getOperator()
Returns the operator.
Returns:
{String} operator

{Array} getValues()
Return string values. If only one argument was passed to setValues(), then the returned value is the one from the argument. If two arguments were passed to setValues() or an array, then the return value is an array of values.
Returns:
{Array} value or array of values.

setColumnName(columnName)
Sets the column name.
Parameters:
{String} columnName

setOperator(operator)
Sets the operator.
Parameters:
{String} operator

setValues(value1, value2)
Set string values for the filter, according to the operator. Takes either one or two values, or one array of values.
Parameters:
{Array} value1
value of array of values
{Array} value2
optional value2

Documentation generated by JsDoc Toolkit 2.0.1 on Tue Jan 19 2010 15:56:27 GMT-0800 (PST)