Olympe SDK

Interface: Predicate

olympe.dc.api. Predicate

Methods

<static> and(predicates)

Parameters:
Name Type Argument Description
predicates olympe.dc.api.Predicate <repeatable>
Returns:
Type
olympe.dc.api.predicates.And

<static> contains(property, value [, caseSensitive])

Parameters:
Name Type Argument Default Description
property olympe.dc.Tag
value string
caseSensitive boolean <optional>
 false
Returns:
Type
olympe.dc.api.predicates.Contains

<static> deserialize(ser)

Parameters:
Name Type Description
ser Object
Returns:
Type
olympe.dc.api.Predicate

<static> equals(property, value)

Parameters:
Name Type Description
property olympe.dc.Tag
value *
Returns:
Type
olympe.dc.api.predicates.Equals

<static> greaterThan(property, valueOrProperty [, strict])

Parameters:
Name Type Argument Default Description
property olympe.dc.Tag
valueOrProperty number | olympe.dc.Tag
strict boolean <optional>
 true
Returns:
Type
olympe.dc.api.predicates.InequalityOperator

<static> not(predicate)

Parameters:
Name Type Description
predicate olympe.dc.api.Predicate
Returns:
Type
olympe.dc.api.predicates.Not

<static> or(predicates)

Parameters:
Name Type Argument Description
predicates olympe.dc.api.Predicate <repeatable>
Returns:
Type
olympe.dc.api.predicates.Or

<static> regex(property, value [, caseSensitive])

Parameters:
Name Type Argument Default Description
property olympe.dc.Tag
value RegExp
caseSensitive boolean <optional>
 true
Returns:
Type
olympe.dc.api.predicates.Regex

<static> smallerThan(property, valueOrProperty [, strict])

Parameters:
Name Type Argument Default Description
property olympe.dc.Tag
valueOrProperty number | olympe.dc.Tag
strict boolean <optional>
 true
Returns:
Type
olympe.dc.api.predicates.InequalityOperator

<abstract> clear(tag, index)

Unregister callback

Parameters:
Name Type Description
tag string
index string

<abstract> execute(tag)

Apply the predicate to given value

Parameters:
Name Type Description
tag string

of instance to test predicate
Returns:

if predicates passes

Type
boolean

<abstract> observe(tag, index, callback)

Define testing on a dataflow string

Parameters:
Name Type Description
tag string
index string
callback olympe.dc.api.Predicate.PredicateCallback

<abstract> serialize()

Serialize the predicate

Returns:
Type
Object

<abstract> toString()

Gets a string representation of this predicate

Returns:

The string representation

Type
string

Type Definitions

PredicateCallback(result)

Parameters:
Name Type Description
result boolean