Skip to main content
Pentaho Documentation

filter

pentaho.data. filter

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.

AbstractType

The base type class of filter types.

And

The And filter represents a boolean conjunction (an And) filter.

AndType

The type class of the And filter type.

False

The False type represents a filter that encompasses no data.

FalseType

The type class of the False filter type.

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.

IsEqualType

The type class of the equality filter type.

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.

IsGreaterOrEqualType

The type class of the greater or equal than filter type.

IsGreaterType

The type class of the strict greater than filter type.

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.

IsLessOrEqualType

The type class of the less or equal than filter type.

IsLessType

The type class of the strict less than filter type.

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.

IsLikeType

The type class of the is-like filter type.

Not

The Not type represents a negation filter.

NotType

The type class of the Not filter type.

Or

The Or filter represents a boolean disjunction (an Or) filter.

OrType

The type class of Or filter types.

Property

The base class of filters that filter elements in a set by matching the value of a given property against a criteria/condition.

PropertyType

The base type class of filter types.

Tree

The base class of filters that combine other filters.

TreeType

The base type class of Tree filter types.

True

The True type represents a filter that encompasses all and any data.

TrueType

The type class of the True filter type.

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

See also: pentaho.data.filter.Abstract#kind

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

See also: pentaho.data.filter.Abstract#visit , pentaho.data.filter.Tree#visit