filter

Last updated
Save as PDF

pentaho .data.filter

The filter namespace constitutes the Pentaho Filter API and contains types for expressing intensional data filters.

The standard filter types are:

pentaho/data/filter/abstract

Source: doc-js/pentaho/data/filter/_namespace.jsdoc, line 20

Child Namespaces

Name	Summary
spec	The `filter.spec` namespace contains specification interfaces for filters.

Classes

Name	Summary
Abstract	The base class of filter types.
And	The `And` filter represents a boolean conjunction (an And) filter.
False	The `False` type represents a filter that encompasses no data.
IsEqual	The `IsEqual` class represents an equality filter. This filter selects elements having the value of a certain property equal to a reference value: `value`.
IsGreater	The `IsGreater` class represents a filter for being strictly greater than a given value. The filter selects elements having the value of a certain property strictly greater than a reference value: `value`.
IsGreaterOrEqual	The `IsGreaterOrEqual` class represents a filter for being greater than or equal to a given value. The filter selects elements having the value of a certain property greater or equal to a reference value: `value`.
IsLess	The `IsLess` class represents a filter for being strictly less than a given value. The filter selects elements having the value of a certain property strictly less than a reference value: `value`.
IsLessOrEqual	The `IsLessOrEqual` class represents a filter for being less than or equal to a given value. The filter selects elements having the value of a certain property less or equal than a reference value: `value`.
IsLike	The `IsLike` class represents a simple string matching filter. This filter selects elements having the formatted value match an affix (ie prefix, suffix or infix) of a reference value: `value`.
Not	The `Not` type represents a negation filter.
Or	The `Or` filter represents a boolean disjunction (an Or) filter.
Property	The base class of filters that filter elements in a set by matching the value of a given property against a criteria/condition.
Tree	The base class of filters that combine other filters.
True	The `True` type represents a filter that encompasses all and any data.

Members

Name	Description
KnownFilterKind : `string`	The `KnownFilterKind` enum is the class of names of the standard, concrete `filter` types.

Members Details

KnownFilterKind: string

The KnownFilterKind enum is the class of names of the standard, concrete filter types.

Properties:
Name	Default Value	Description
And : `string`	and	The `And` filter kind.
Or : `string`	or	The `Or` filter kind.
Not : `string`	not	The `Not` filter kind.
IsEqual : `string`	isEqual	The `IsEqual` filter kind.
IsIn : `string`	isIn	The `IsIn` filter kind.
IsGreater : `string`	isGreater	The `IsGreater` filter kind.
IsLess : `string`	isLess	The `IsLess` filter kind.
IsGreaterOrEqual : `string`	isGreaterOrEqual	The `IsGreaterOrEqual` filter kind.
IsLessOrEqual : `string`	isLessOrEqual	The `IsLessOrEqual` filter kind.
IsLike : `string`	isLike	The `IsLike` filter kind.
True : `string`	true	The `True` filter kind.
False : `string`	false	The `False` filter kind.

Source: javascript/web/pentaho/data/filter/KnownFilterKind.js, line 29

Type Definitions

FTransformer(filter, filterOperands) : !Array.<pentaho.data.filter.Abstract> | pentaho.data.filter.Abstract

Function that is called for each filter in a filter tree during a visit operation.

Source: doc-js/pentaho/data/filter/FTransformer.jsdoc, line 17

Parameters:
Name	Default Value	Summary
filter : `pentaho.data.filter.Abstract`		The filter to be transformed.
filterOperands : `Array.<pentaho.data.filter.Abstract>` Optional		The list of filter operands.

Returns:
Name	Description
`!Array.<pentaho.data.filter.Abstract>` \| `pentaho.data.filter.Abstract`