Skip to main content
Pentaho Documentation

filter

pentaho.type.filter

The filter namespace contains types for expressing intensional filters of complex values or lists thereof.

Source: doc-js/pentaho/type/filter/_namespace.jsdoc, line 17

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.

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.

True : string true

The True filter kind.

False : string false

The False filter kind.

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

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

Type Definitions

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

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

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

Parameters:
Name Default Value Summary
filter : pentaho.type.filter.Abstract

The filter to be transformed.

filterOperands : Array.<pentaho.type.filter.Abstract>
 
Optional

The list of filter operands.

Returns:
Name Description
!Array.<pentaho.type.filter.Abstract> | pentaho.type.filter.Abstract

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