Olympe SDK

Class: Filter

olympe.dc.transformers. Filter

Transformer filtering a set of instances according to a predicate.

Example:

const lst = users.transform(
    new olympe.dc.transformers.Filter(
      new olympe.dc.predicates.Not(new olympe.dc.predicates.InstanceOf(composer.models.LocalUserRoot))
    )
);

new Filter(predicate)

Creates an instance of the Filter transformer with the given predicate.

Parameters:
Name Type Description
predicate olympe.dc.Predicate
Implements:
See:

Methods

getInternalPaths()

Implements:
Returns:
Type
Array.<!Array.<!olympe.dc.query.Relation>>

getName()

Gets this Transformer unique name.

Implements:
Returns:

The name.

Type
string

getPredicate()

Gets the predicate for this filter.

Returns:

The predicate.

Type
olympe.dc.Predicate

getTransform(manager, stateResolver, callback)

Get the transformer's transform function. This is the method that implementations of Transformer must provide and is where the actual transformation will take place.

Parameters:
Name Type Description
manager olympe.dc.Manager

The DC manager.
stateResolver olympe.dc.ranking.StateResolver

The state resolver.
callback olympe.dc.Manager.TransformationCallback

The callback.
Implements:
Returns:

The transform function.

Type
olympe.dc.Manager.TransformationCallback

getValueType()

Gets the transformed item's value type. A null value means that the transformer will not change the type of the values (e.g. a sort transformer).

Implements:
Returns:

Returns the transformed listDef value new type or null if this transformer does not change it

Type
function

serialize(parameters)

Serializes the transformer.

Parameters:
Name Type Description
parameters olympe.dc.query.Parameters

The parameters for the serialization.
Implements:
Throws:

If the transformer is not serializable.

Type
Error
Returns:

The JSON representation.

Type
string

toString()

Gets a string representation of the transformer.

Implements:
Returns:

The representation.

Type
string