Olympe SDK

Class: HasRelatedTree

olympe.dc.predicates. HasRelatedTree

The HasRelatedTree predicate checks if an instance is related to another with a specific tag or not. It also support the check of recursive related. Compare to the standard olympe.dc.predicates.HasRelated, it is optimal to use this predicate when the working graph cluster takes a shape like the Eiffel Tower (when most of instances are linked to a common trunk).

origins ◉-----+ ◉--+ \ Target instance ◉---}---◉ === ◉ === ◉ === ◉ ◉--+ / common trunk ◉-----+

new HasRelatedTree(relationsTags, relationsDirections [, tags])

Checks whether an instance with tag "tag" can be reach by following the path described by "relationTags"

Parameters:
Name Type Argument Description
relationsTags Array.<(string|olympe.dc.registry.Relation|olympe.dc.transformers.RecursiveRelated)> | string | olympe.dc.registry.Relation | olympe.dc.transformers.RecursiveRelated
relationsDirections Array.<olympe.dc.Direction> | olympe.dc.Direction
tags Array.<olympe.dc.InstanceTag> <optional>
Implements:

Methods

getInternalPaths()

Returns the path in the graph followed by this predicate to be evaluated.

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

getName()

Gets the name of this Predicate.

Implements:
Returns:

The name.

Type
string

serialize(parameters)

Serializes the predicate.

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

Serialization parameters.
Implements:
Throws:

If the predicate is not serializable.

Type
Error
Returns:

A string containing the serialized form.

Type
string

test(dcManager, tag)

Checks whether an instance matches this predicate.

Parameters:
Name Type Description
dcManager olympe.dc.Manager

The DC manager.
tag string

The tag of the instance to test.
Implements:
Returns:

The result of the test as a boolean (or OBoolean) or a node (or proxy) of those types

Type
boolean | olympe.df.Node | olympe.df.OBoolean | olympe.df.Proxy

toString()

Gets a string representation of this Predicate.

Implements:
Returns:

The string representation.

Type
string

Type Definitions

InstancePropagator(propagator, added, tag)

Parameters:
Name Type Description
propagator olympe.dc.predicates.HasRelatedTree.Propagator
added boolean
tag string

Propagator(counter)

Parameters:
Name Type Description
counter number