org.janusgraph.core

Interface RelationType

All Superinterfaces:

org.apache.tinkerpop.gremlin.structure.Element, org.apache.tinkerpop.gremlin.structure.util.Host, Idfiable, JanusGraphElement, JanusGraphSchemaElement, JanusGraphSchemaType, JanusGraphVertex, Namifiable, Removable, org.apache.tinkerpop.gremlin.structure.Vertex

All Known Subinterfaces:

EdgeLabel, InternalRelationType, PropertyKey, SystemRelationType

All Known Implementing Classes:

BaseKey, BaseLabel, BaseRelationType, EdgeLabelVertex, EmptyRelationType, ImplicitKey, PropertyKeyVertex, RelationTypeVertex

public interface RelationType
extends JanusGraphVertex, JanusGraphSchemaType

RelationType defines the schema for JanusGraphRelation. RelationType can be configured through RelationTypeMaker to provide data verification, better storage efficiency, and higher retrieval performance.
Each JanusGraphRelation has a unique type which defines many important characteristics of that relation.
RelationTypes are constructed through RelationTypeMaker which is accessed in the context of a JanusGraphTransaction via SchemaManager.makePropertyKey(String) for property keys or SchemaManager.makeEdgeLabel(String) for edge labels. Identical methods exist on JanusGraph. Note, relation types will only be visible once the transaction in which they were created has been committed.
RelationType names must be unique in a graph database. Many methods allow the name of the type as an argument instead of the actual type reference. That also means, that edge labels and property keys may not have the same name.

Author:

Matthias Bröcheler (me@matthiasb.com);

See Also:

JanusGraphRelation, RelationTypeMaker, "Schema and Data Modeling" manual chapter

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Vertex

org.apache.tinkerpop.gremlin.structure.Vertex.Exceptions

Field Summary

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Vertex

DEFAULT_LABEL, EMPTY_ARGS

Method Summary

Modifier and Type	Method and Description
boolean	isEdgeLabel() Checks if this relation type is an edge label
boolean	isPropertyKey() Checks if this relation type is a property key

Methods inherited from interface org.janusgraph.core.JanusGraphVertex

addEdge, isModified, label, property, property, property, query, vertexLabel

Methods inherited from interface org.janusgraph.core.JanusGraphElement

graph, hasId, id, isLoaded, isNew, isRemoved, longId, remove, valueOrNull

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Vertex

edges, properties, property, vertices

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Element

keys, value, values

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Host

getHostingVertex

Methods inherited from interface org.janusgraph.core.schema.JanusGraphSchemaType

isNew

Methods inherited from interface org.janusgraph.core.Namifiable

name

Method Detail

isPropertyKey

boolean isPropertyKey()

Checks if this relation type is a property key

Returns:

true, if this relation type is a property key, else false.

See Also:

PropertyKey

isEdgeLabel

boolean isEdgeLabel()

Checks if this relation type is an edge label

Returns:

true, if this relation type is a edge label, else false.

See Also:

EdgeLabel