Class actuate.xtabanalyzer.Filter

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

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.xtabanalyzer.Filter(levelName, levelAttributeName, operator, values, filterType) The Filter class is used to specify a filter condition.

Field Summary
Field Attributes	Field Name and Description
<static> <constant>	BETWEEN Filter operator for "between".
<static> <constant>	BOTTOM_N Filter operator for "bottom N".
<static> <constant>	BOTTOM_PERCENT Filter operator for "bottom percent".
<static> <constant>	EQ Filter operator for "equals" Expression: "value1 = value2"
<static> <constant>	FALSE Filter operator for "is false".
<static> <constant>	FILTER_TYPE_SIMPLE Filter type for "simple"
<static> <constant>	FILTER_TYPE_SLICER Filter type for "slicer"
<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".
<static> <constant>	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".
<static> <constant>	MATCH Filter operator for "match".
<static> <constant>	NOT_BETWEEN Filter operator for "between".
<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".
<static> <constant>	NOT_LIKE Filter operator for "not like".
<static> <constant>	NOT_MATCH Filter operator for "not match".
<static> <constant>	NOT_NULL Filter operator for "is not null".
<static> <constant>	NULL Filter operator for "is null".
<static> <constant>	TOP_N Filter operator for "top N".
<static> <constant>	TOP_PERCENT Filter operator for "top percent".
<static> <constant>	TRUE Filter operator for "is true".

Method Summary
Method Attributes	Method Name and Description
	getFilterType() Returns the filter type.
	getLevelAttributeName() Returns the dimension level attribute name to filter on.
	getLevelName() Returns the dimension level name to filter on.
	getOperator() Returns the operator.
	getValues() Return string values.
	setFilterType(filterType) Sets the filter type.
	setLevelAttributeName(levelAttributeName) Sets the dimension level attribute name to filter on.
	setLevelName(levelName) Sets the dimension level name to filter on.
	setOperator(operator) Sets the operator.
	setValues(value1, value2) Set string values for the filter, according to the operator.

Class Detail

actuate.xtabanalyzer.Filter(levelName, levelAttributeName, operator, values, filterType)

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.

Parameters:
{String} levelName: Dimension level full name
{String} levelAttributeName: Dimension level attribute name
{String} operator: Filter operator
{Array} values: Value array
{String} filterType: Filter Type

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> FILTER_TYPE_SIMPLE

Filter type for "simple"

<static> <constant> FILTER_TYPE_SLICER

Filter type for "slicer"

<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> 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} getFilterType()

Returns the filter type.

Returns:: {String} filterType

{String} getLevelAttributeName()

Returns the dimension level attribute name to filter on.

Returns:: {String} level attribute name to filter on

{String} getLevelName()

Returns the dimension level name to filter on.

Returns:: {String} level name to filter on

{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} values

{void} setFilterType(filterType)

Sets the filter type.

Parameters:
{String} filterType: Filter type

Returns:: {void}

{void} setLevelAttributeName(levelAttributeName)

Sets the dimension level attribute name to filter on.

Parameters:
{String} levelAttributeName: Level attribute name to filter on

Returns:: {void}

{void} setLevelName(levelName)

Sets the dimension level name to filter on.

Parameters:
{String} levelName: Level name to filter on

Returns:: {void}

{void} setOperator(operator)

Sets the operator.

Parameters:
{String} operator: Filter operator

Returns:: {void}

{void} 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: The first one value
{Array} value2: optional The second one value

Returns:: {void}

Classes

Class actuate.xtabanalyzer.Filter