Class actuate.xtabanalyzer.Filter
Description
The Filter class creates a filter condition on a cross tab dimension level. The condition is expressed as value1 operator value2. The values can either be a single value, or an array of values, depending on the operator. For example, IN can be expressed as value1 IN value2 value3 ... valueN.
Constructor
Syntax
actuate.data.Filter(string levelName, string levelAttributeName, string operator, string value, string filterType)
actuate.data.Filter(string levelName, string levelAttributeName, string operator, string value1, string value2, string filterType)
actuate.data.Filter(string levelName, string levelAttributeName, string operator, string[ ] values, string filterType)
Constructs a cross tab Filter object.
Parameters
levelName
String. The dimension level full name.
levelAttributeName
String. The dimension level attribute name.
operator
String. The operator can be any operator. Table 15‑8 lists the valid filter operators and the number of arguments to pass to the constructor or setValues( ).
Table 15‑8 Filter operators
Operator
Description
Number of arguments
BETWEEN
Between an inclusive range
2
BOTTOM_N
Matches the bottom n values
1
BOTTOM_PERCENT
Matches the bottom percent of the values
1
EQ
Equal
1
FALSE
Matches false Boolean values
0
GREATER_THAN
Greater than
1
GREATER_THAN_OR_EQUAL
Greater than or equal
1
IN
Matches any value in a set of values
1+
LESS_THAN
Less than
1
LESS_THAN_OR_EQUAL
Less than or equal
1
LIKE
Search for a pattern
1
MATCH
Equal
1
NOT_BETWEEN
Not between an inclusive range
2
NOT_EQ
Not equal
1
NOT_IN
Does not match any value in a set of values
1+
NOT_LIKE
Searches for values that do not match a pattern
1
NOT_MATCH
Not equal
1
NOT_NULL
Is not null
0
NULL
Is null
0
TOP_N
Matches the top n values
1
TOP_PERCENT
Matches the top percent of the values
1
TRUE
Matches true Boolean values
0
value
String. The value to compare to the column value.
value1
String. The first value to compare to the column value for the BETWEEN or NOT_BETWEEN operators.
value2
String. The second value to compare to the column value for the BETWEEN or NOT_BETWEEN operators.
values
Array of strings. The values to compare to the column value for the IN and NOT_IN operators.
filterType
String. The filter type.
Function summary
Table 15‑9 lists actuate.xtabanalyzer.Filter functions.
Table 15‑9 actuate.xtabanalyzer.Filter functions 
Function
Description
getFilterType( )
Returns the filter type
getLevelAttributeName( )
Returns the dimension level attribute name
getLevelName( )
Returns the name of the filtered level
getOperator( )
Returns the filter operator
getValues( )
Returns the set of values the filter is using
setFilterType( )
Sets the filter type
setLevelAttributeName( )
Sets the dimension level attribute name
setLevelName( )
Sets the dimension level name
setOperator( )
Sets the filter operator
setValues( )
Sets the values for the filter
getFilterType
Syntax
string Filter.getFilterType( )
Returns the filter type.
Returns
String. The filter type.
Example
This example retrieves the filter type for a filter:
function getType(filter){
if(filter) {
return filter.getFilterType( );
}
else{
return null;
}
}
getLevelAttributeName
Syntax
string Filter.getLevelAttribute Name( )
Returns the name of the dimension level attribute to which this filter applies.
Returns
String. The level attribute name.
Example
This example retrieves the filter level attribute name for a filter:
function getLevelAttribute(filter){
if(filter) {
return filter.getLevelAttributeName( );
}
else{
return null;
}
}
getLevelName
Syntax
string Filter.getLevelName( )
Returns the name of the dimension level to which this filter applies.
Returns
String. A level name.
Example
This example retrieves the filter level name for a filter:
function getLevel(filter){
if(filter) {
return filter.getLevelName( );
}
else{
return null;
}
}
getOperator
Syntax
string Filter.getOperator( )
Returns the filter operator.
Returns
String. The filter operator.
Example
This example retrieves the filter operator:
function getFilterOp(filter){
if(filter){
return filter.getOperator( );
}else{
return null;
}
}
getValues
Syntax
string[ ] Filter.getValues( )
Returns an array containing the values used in the filter.
Returns
Array of strings. The values for the filter.
Example
This example retrieves the filter level name for a filter:
function getFilterOp(filter){
if(filter){
return filter.getValues( );
}else{
return null;
}
}
setFilterType
Syntax
void Filter.setFilterType(string filterType)
Sets the filter type to filter.
Parameter
filterType
String. The type of filter.
Example
This example sets the filter type to equality:
function filterLevel( ){
var filterType = "equality";
var filter = new actuate.xtabanalyzer.Filter("levelName","attributeName","EQ","2000","blank");
filter.setFilterType(filterType);
crosstab.setFilters( filter );
crosstab.submit( );
}
setLevelAttributeName
Syntax
void Filter.setLevelAttributeName(string levelAttributeName)
Sets the dimension level attribute to filter on by name.
Parameter
levelAttributeName
String. The name of the level attribute to filter.
Example
This example sets the level attribute name to attributeName:
function filterLevel( ){
var attributeName = "attributeName";
var filter = new actuate.xtabanalyzer.Filter("levelName","blank","EQ","2000","equality");
filter.setLevelAttributeName(attributeName);
crosstab.setFilters( filter );
crosstab.submit( );
}
setLevelName
Syntax
void Filter.setLevelName(string level)
Sets the level to filter by name.
Parameter
level
String. The name of the level to filter.
Example
This example sets the filter level name to levelName:
function filterLevel( ){
var levelName = "levelName";
var filter = new actuate.xtabanalyzer.Filter("blank","attributeName",EQ","2000","equality");
filter.setLevelName(levelName);
crosstab.setFilters( filter );
crosstab.submit( );
}
setOperator
Syntax
void Filter.setOperator(string operator)
Sets the filter operator.
Parameter
operator
String. The filter operator.
Example
This example sets the filter operator to EQ:
function filterLevel( ){
var operator = "EQ";
var filter = new actuate.xtabanalyzer.Filter("levelName","attributeName","NOT","2000","equality");
filter.setOperator(operator);
crosstab.setFilters( filter );
crosstab.submit( );
}
setValues
Syntax
void Filter.setValues(string[ ] value1, string[ ] value2)
Sets the values for the filter.
Parameters
value1
String or array of strings. The first value of the filter.
value2
String or array of strings. Optional. The second value of the filter.
Example
This example sets the filter values to 2000 and 2004:
function filterLevel( ){
if(crosstab){
var filterValue = "2000;2004";
var filter = new actuate.xtabanalyzer.Filter("levelName","attributeName","BETWEEN");
filter.setValues(filterValue.split(";") );
crosstab.setFilters( filter );
crosstab.submit( );
}
}