Olympe SDK

Class: MultiRelated

olympe.dc.transformers. MultiRelated

A transformer that returns all related instances (by following multiple relations in the specified direction). This transformer is used to follow typo relations

new MultiRelated(relations [, direction])

Creates a new MultiRelated transformer.

Parameters:
Name Type Argument Default Description
relations Array.<string>

Relation tags.
direction olympe.dc.Direction <optional>
 olympe.dc.Direction.DESTINATION

Relation direction.
Implements:

Methods

getDirection()

Gets the relation direction.

Returns:

The direction.

Type
olympe.dc.Direction

getName()

Gets this Transformer unique name.

Implements:
Returns:

The name.

Type
string

getTags()

Gets the array of tags of the multiple relation followed by this transformer.

Returns:

The tags of the relations.

Type
Array.<string>

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