Schema

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. def ++(other: Schema): Schema

   

4. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

5. def allLabelCombinations: Set[Set[String]]

   

6. def allNodeKeys: PropertyKeys

   

7. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

8. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

9. def combinationsFor(knownLabels: Set[String]): Set[Set[String]]

   

   Given a set of labels that a node definitely has, returns all combinations of labels that the node could possibly have.

10. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. def forNodeScan(labelConstraints: Set[String]): Schema

    

    Returns the sub-schema for a node scan under the given constraints.

    Returns the sub-schema for a node scan under the given constraints. Labels are interpreted as constraints on the resulting Schema. If no labels are specified, this means the resulting node can have any valid label combination.

    labelConstraints

    Specifies the labels that the node is guaranteed to have

    returns

    sub-schema for labelConstraints

13. def forRelationship(relType: CTRelationship): Schema

    

    Returns the sub-schema for relType

    Returns the sub-schema for relType

    relType

    Specifies the type for which the schema is extracted

    returns

    sub-schema for relType

14. def fromNodeEntity(labels: Set[String]): Schema

    

    Given the current schema, construct a new Schema for an entity with a given set of labels.

    Given the current schema, construct a new Schema for an entity with a given set of labels. If the set of labels is empty, this means that the resulting schema will only have properties present on nodes that have no labels.

    labels

    labels present on the node entity

15. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

16. def impliedLabels(knownLabels: Set[String]): Set[String]

    

    Given a set of labels that a node definitely has, returns all labels the node _must_ have.

17. def impliedLabels(knownLabels: String*): Set[String]

    

    Given a set of labels that a node definitely has, returns all labels the node _must_ have.

18. lazy val impliedLabels: ImpliedLabels

    

    Implied labels for each existing label

19. def isEmpty: Boolean

    

20. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

21. def keysFor(labels: String*): PropertyKeys

    

    Returns the property keys that exist on any of the labels.

    Returns the property keys that exist on any of the labels. Types of conflicting property keys are joined.

    labels

    labels for which to return the property keys

    returns

    property keys for labels

22. def keysFor(labelCombinations: Set[Set[String]]): PropertyKeys

    

    Computes property keys for the set of label combinations.

    Computes property keys for the set of label combinations.

    labelCombinations

    label combinations to consider.

    returns

    typed property keys, with joined or nullable types for conflicts.

23. lazy val labelCombinations: LabelCombinations

    

    Groups of labels where each group contains possible label combinations.

24. val labelPropertyMap: LabelPropertyMap

    

25. val labels: Set[String]

    

26. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

27. def nodeKeyType(labels: Set[String], key: String): Option[CypherType]

    

    Computes the type (if any) for a property given a predicate of labels.

    Computes the type (if any) for a property given a predicate of labels.

    labels

    the labels predicate; either a lower bound of expected labels, or a disjunction of possible labels

    key

    the property key

    returns

    the Cypher type, if any, mapped to the key for nodes that pass the predicate

28. def nodeKeys(label: String): PropertyKeys

    

29. def nodeKeys(labels: Set[String]): PropertyKeys

    

    Given a set of labels that a node definitely has, returns its property schema.

    Given a set of labels that a node definitely has, returns its property schema.

    TODO: consider implied labels here?

30. def nodeKeys(labels: String*): PropertyKeys

    

31. final def notify(): Unit

    

    Definition Classes

    AnyRef

32. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

33. def pretty: String

    

34. val relTypePropertyMap: RelTypePropertyMap

    

35. def relationshipKeyType(types: Set[String], key: String): Option[CypherType]

    

36. def relationshipKeys(typ: String): Map[String, CypherType]

    

    Returns the property schema for a given relationship type

37. val relationshipTypes: Set[String]

    

38. def sparkCompatibleJoin(label: Option[String], key: String, t1: CypherType, t2: CypherType): CypherType

    

39. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

40. def toString(): String

    

    Definition Classes

    Schema → AnyRef → Any

41. def verify: Schema

    

42. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

43. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

44. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

45. def withNodePropertyKeys(nodeLabels: Set[String], keys: PropertyKeys): Schema

    

    Adds information about a label and its associated properties to the schema.

    Adds information about a label and its associated properties to the schema. The arguments provided to this method are interpreted as describing a whole piece of information, meaning that for a specific instance of the label, the given properties were present in their exact given shape. For example, consider

    val s = schema.withNodePropertyKeys("Foo")("p" -> CTString, "q" -> CTInteger)
    val t = s.withNodePropertyKeys("Foo")("p" -> CTString)

    The resulting schema (assigned to t) will indicate that the type of q is CTInteger.nullable, as the schema understands that it is possible to map :Foo to both sets of properties, and it calculates the join of the property types, respectively.

    nodeLabels

    the node labels to add to the schema

    keys

    the typed property keys to associate with the labels

    returns

    a copy of the Schema with the provided new data

46. def withNodePropertyKeys(nodeLabels: String*)(keys: (String, CypherType)*): Schema

    

47. def withRelationshipPropertyKeys(typ: String, keys: PropertyKeys): Schema

    

    Adds information about a relationship type and its associated properties to the schema.

    Adds information about a relationship type and its associated properties to the schema. The arguments provided to this method are interpreted as describing a whole piece of information, meaning that for a specific instance of the relationship type, the given properties were present in their exact given shape. For example, consider

    val s = schema.withRelationshipPropertyKeys("FOO")("p" -> CTString, "q" -> CTInteger)
    val t = s.withRelationshipPropertyKeys("FOO")("p" -> CTString)

    The resulting schema (assigned to t) will indicate that the type of q is CTInteger.nullable, as the schema understands that it is possible to map :FOO to both sets of properties, and it calculates the join of the property types, respectively.

    typ

    the relationship type to add to the schema

    keys

    the properties (name and type) to associate with the relationship type

    returns

    a copy of the Schema with the provided new data

48. def withRelationshipPropertyKeys(typ: String)(keys: (String, CypherType)*): Schema

    

49. def withRelationshipType(relType: String): Schema