Olympe SDK

Class: ImplicitGraphQuery

ImplicitGraphQuery

An ImplicitGraphQuery is a GraphQuery that uses followRules instead of blocks to describe its coverage.

new ImplicitGraphQuery(graphdef, parentContext)

Creates an instance of ImplicitGraphQuery, i.e. an object that monitors the state of a graph query with follow rules

Parameters:
Name Type Description
graphdef olympe.dc.GraphDef
parentContext olympe.df.ExecutionContext

Extends

Members

<protected, non-null> allBlocks :Map.<string, !olympe.dc.query.GraphQueryBlock>

Type:
Inherited From:
Overrides:

<protected, non-null> context :olympe.df.ExecutionContext

Type:
Inherited From:
Overrides:

<protected> graphdef :olympe.dc.GraphDef

Type:
Inherited From:
Overrides:

<protected> id :string

Type:
  • string
Inherited From:
Overrides:

<protected> logger :olympe.logging.Channel

Type:
  • olympe.logging.Channel
Inherited From:
Overrides:

<protected, non-null> rootBlockIds :Array.<string>

Type:
  • Array.<string>
Inherited From:
Overrides:

<protected> rootTag :string

Type:
  • string
Inherited From:
Overrides:

Methods

applyResult(result)

Update the graphdef with the specified result.

Parameters:
Name Type Description
result olympe.dc.query.GraphResult

the graph result
Inherited From:
Overrides:

covers(graphQuery)

Checks if a path query is covered by this graphdef

Parameters:
Name Type Description
graphQuery olympe.dc.query.GraphQuery

The graphdef whose coverage by the current GraphQuery must be checked
Inherited From:
Overrides:
Returns:
Type
boolean

getBlocks()

Gets the list of all blocks in that graph query.

Inherited From:
Overrides:
Returns:

the list of blocks.

Type
Array.<!olympe.dc.query.GraphQueryBlock>

getDestination()

Return the destination of this graph query (based on the first root tag).

Inherited From:
Overrides:
Returns:

the destination

Type
string

getFollowRules()

Return the rules activated for this query

Returns:

the rules of this query

Type
olympe.dc.FollowRules

getGraphdef()

Returns the graphdef that initiated this graph query.

Inherited From:
Overrides:
Returns:
Type
olympe.dc.GraphDef

getId()

Gets the id of the graphdef.

Inherited From:
Overrides:
Returns:

the id.

Type
string

getOperation()

Gets the operation associated to this graphdef.

Inherited From:
Overrides:
Returns:

the operation.

Type
olympe.dc.GraphDefOperation

getRootBlocks()

Gets the list of blocks representing the first related level present in this graph query.

Inherited From:
Overrides:
Returns:

the list of blocks

Type
Array.<!olympe.dc.query.GraphQueryBlock>

getRootTag()

Gets the root tags of the graphdef.

Inherited From:
Overrides:
Returns:

the root tags.

Type
string

instancesIterator()

Return an iterator over all the instances currently covered by this graphdef

Inherited From:
Overrides:
Returns:
Type
!Generator.<string> | !Iterable.<string>

isReady()

Return true if the current query is ready.

Inherited From:
Overrides:
Returns:
Type
boolean

notificationUpdate(notification)

Update the graphdef with the specified notification.

Parameters:
Name Type Description
notification olympe.dc.query.GraphNotification

The notification.
Inherited From:
Overrides:

offReady(id)

Unregister the callback associated to the specified id if any.

Parameters:
Name Type Description
id string
Inherited From:
Overrides:
Returns:

true if a callback has been unregistered.

Type
boolean

onDestroy(callback)

Register a callback to call when the graph query context is destroyed

Parameters:
Name Type Description
callback function

The callback to register.
Inherited From:
Overrides:

onReady(callback [, id])

Register a callback to execute when the subscription is ready: when the initial result has been processed. If the query is already ready, directly execute the callback

Parameters:
Name Type Argument Description
callback function
id string <optional>
Inherited From:
Overrides:
Returns:

the id used to register the callback.

Type
string

release()

Notify this subscription that it can be released, which will trigger its garbage collection

Inherited From:
Overrides:

setReady()

Set this graph query as ready and execute the onReady callbacks.

Inherited From:
Overrides: