NodeMapping

Represents a mapping from a source with key-based access to node components (e.g. a table definition) to a Cypher node. The purpose of this class is to define a mapping from an external data source to a property graph.

Construct a NodeMapping starting with NodeMapping#on.

The sourceIdKey represents a key to the node identifier within the source data. The retrieved value from the source data is expected to be a scala.Long value that is unique among nodes.

The impliedLabels represent a set of node labels.

The optionalLabelMapping represent a map from node labels to keys in the source data. The retrieved value from the source data is expected to be a scala.Boolean value indicating if the label is present on that node.

The propertyMapping represents a map from node property keys to keys in the source data. The retrieved value from the source is expected to be convertible to a valid org.opencypher.okapi.api.value.CypherValue.

Linear Supertypes

Serializable, Serializable, Product, Equals, EntityMapping, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def cypherType: CTNode

Definition Classes
NodeMapping → EntityMapping
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val impliedLabels: Set[String]

set of node labels
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val optionalLabelMapping: Map[String, String]

mapping from label to source key
def preventOverwritingProperty(propertyKey: String): Unit

Attributes
protected
Definition Classes
EntityMapping
val propertyMapping: Map[String, String]

mapping from property key to source property key
mapping from property key to source property key

Definition Classes
NodeMapping → EntityMapping
val sourceIdKey: String

key to access the node identifier in the source data
key to access the node identifier in the source data

Definition Classes
NodeMapping → EntityMapping
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withImpliedLabel(label: String): NodeMapping
def withImpliedLabels(labels: String*): NodeMapping
def withOptionalLabel(tuple: (String, String)): NodeMapping
def withOptionalLabel(label: String, sourceLabelKey: String): NodeMapping
def withOptionalLabel(label: String): NodeMapping
def withOptionalLabels(labels: String*): NodeMapping
def withPropertyKey(propertyKey: String, sourcePropertyKey: String): NodeMapping
def withPropertyKey(property: String): NodeMapping
def withPropertyKey(tuple: (String, String)): NodeMapping
def withPropertyKeys(properties: String*): NodeMapping

Related Docs: object NodeMapping | package conversion

final case class NodeMapping extends EntityMapping with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def cypherType: CTNode

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val impliedLabels: Set[String]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val optionalLabelMapping: Map[String, String]

def preventOverwritingProperty(propertyKey: String): Unit

val propertyMapping: Map[String, String]

val sourceIdKey: String

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withImpliedLabel(label: String): NodeMapping

def withImpliedLabels(labels: String*): NodeMapping

def withOptionalLabel(tuple: (String, String)): NodeMapping

def withOptionalLabel(label: String, sourceLabelKey: String): NodeMapping

def withOptionalLabel(label: String): NodeMapping

def withOptionalLabels(labels: String*): NodeMapping

def withPropertyKey(propertyKey: String, sourcePropertyKey: String): NodeMapping

def withPropertyKey(property: String): NodeMapping

def withPropertyKey(tuple: (String, String)): NodeMapping

def withPropertyKeys(properties: String*): NodeMapping

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from EntityMapping

Inherited from AnyRef

Inherited from Any

Ungrouped