Olympe SDK

Namespace: dc

olympe. dc

Core DataCloud namespace. Contains all the classes and methods related to building and interacting with the data cloud. Data cloud objects are shared among multiple consumers across the network and are kept synchronised by the Olympe Orchestrator. Subscribing to such an object will get you notifications when one of its properties changes.

The core classes in this namespace are:

See Introduction to the Data Cloud for an overview of these classes and how they interact with each other.

Classes

BurstTransaction
CloudObject
DBView
FileServiceManager
GraphDef
ListDef
ListDefBuilder
Manager
Message
ModelInfo
ModuleInfo
ProcessorCollection
Reference
Transaction

Namespaces

api
comparators
db
predicates
ranking
registry
transaction
transformers
valuedefs

Members

<static> Config :string

DataCloud config

Type:
  • string
Properties:
Name Type Default Description
DEBUG string dc.debug
SUBSCRIBE_ALL string dc.subscribeAll
DEFAULT_SOURCE string dc.defaultSource
FILE_CACHE string dc.fileCache
ERROR_ABSTRACT string dc.errorOnAbstractInstantiation

<static> Direction :string

Relation directions. A direction is said to be 'left' or 'right' depending on whether it ends or originates from the object.

Example: If an object A as String as a model, the relation is depicted as follows:

1

A -[model]-> String

Both A & String are connected via this relation, but it is a 'Right' relation for 'A' while it is a 'Left' relation for 'String'.

Type:
  • string
Properties:
Name Type Default Description
ORIGIN string <
DESTINATION string >

<static, readonly> GraphDefOperation :number

Operations on GraphDefs.

Type:
  • number
Properties:
Name Type Default Description
SUBSCRIBE number 0

Fetch data of the graphdef and subscribe to any update of it. Push the results in the local database.
PULL number 1

Fetch data and push it in the local database.
QUERY number 2

Fetch data but don't push to the local database.
SUBSCRIPTION number 0
GET number 1

<static> InstanceProperty :string

Primitive hardcoded instance properties (that is properties that are not instances of "models.Property")

Type:
  • string
Properties:
Name Type Default Description
VERSION string @v
SOURCE string @s

<static> InstancePropertyType :string

Instance special properties types

Type:
  • string
Properties:
Name Type Default Description
DEFAULT string ?

<static> RelationType :string

Primitive relation types.

Type:
  • string
Properties:
Name Type Default Description
MODEL string ff022000000000000000
EXTEND string ff02200000000000000e
CONTAINS string ff02200000000000000f

<static> SourceEvent :string

Source events.

Type:
  • string
Properties:
Name Type Default Description
ONLINE string online
OFFLINE string offline
INVALIDATE string invalidate

<static> SourceType :string

Source types.

Type:
  • string
Properties:
Name Type Default Description
SELF string self
SERVER string server
PEER string peer
DEFAULT string server

<static> Svc :string

DataCloud services

Type:
  • string
Properties:
Name Type Default Description
MANAGER string dc.Manager
GRAPH string dc.Graph
DBVIEW string dc.DBView
LOGGER string dc.Logger
TRANSACTION_LOGGER string dc.TransactionLogger
FILE_MANAGER string dc.FileServiceManager
ROUTER string dc.Router

<static> Sync

Deprecated:
  • Sync is now just an alias for CloudObject

Methods

<static> dbView()

Return the database view singleton to get data directly from the graph database.

Returns:
Type
olympe.dc.DBView

<static> defineInverseRelation(relation)

Define and return a new relation which is the same as the specified one with the opposite direction.

Parameters:
Name Type Description
relation olympe.dc.registry.Relation
Returns:
Type
olympe.dc.registry.Relation

<static> defineProperty(tag, type)

Define and return a new property associated to the specified tag.

Parameters:
Name Type Description
tag olympe.dc.Tag
type function
Returns:
Type
olympe.dc.registry.Property

<static> defineRelation(tag [, originOrDirection], destination [, direction])

Define and return a new relation associated to the specified tag, with the origin and destination types.

Parameters:
Name Type Argument Description
tag olympe.dc.Tag
originOrDirection function | olympe.dc.Direction <optional>
destination function
direction olympe.dc.Direction <optional>
Returns:
Type
olympe.dc.registry.Relation

<static> getDatabaseManager()

Returns:
Type
olympe.dc.db.DatabaseManager

<static> getFileManager()

Returns:
Type
olympe.dc.FileServiceManager

<static> getManager()

Returns:
Type
olympe.dc.Manager

<static> getQueryManager()

Returns:
Type
olympe.dc.query.QueryManager

<static> getSyncManager()

Returns:
Type
olympe.dc.syncs.SyncManager

<static> getTransactionManager()

Returns:
Type
olympe.dc.transaction.TransactionManager

<static> instanceToTag(instanceOrConstructor)

Gets a tag from the specified InstanceTag or Sync constructor.

Parameters:
Name Type Description
instanceOrConstructor olympe.dc.InstanceTag

The instance, string or type.
Returns:

The tag, or an empty string if none found.

Type
string

<static> register(tag, ctr)

Register the specified constructor as the class associated to the tag.

Parameters:
Name Type Description
tag olympe.dc.Tag
ctr function

Type Definitions

InstanceTag

Deprecated:
  • Yes

<non-null> Tag()