org.janusgraph.graphdb.types.system

Class BaseKey

java.lang.Object

org.janusgraph.graphdb.types.system.EmptyVertex

org.janusgraph.graphdb.types.system.EmptyRelationType

org.janusgraph.graphdb.types.system.BaseRelationType

org.janusgraph.graphdb.types.system.BaseKey

All Implemented Interfaces:

org.apache.tinkerpop.gremlin.structure.Element, org.apache.tinkerpop.gremlin.structure.util.Host, org.apache.tinkerpop.gremlin.structure.Vertex, Idfiable, JanusGraphElement, JanusGraphVertex, Namifiable, PropertyKey, RelationType, JanusGraphSchemaElement, JanusGraphSchemaType, InternalElement, InternalRelationType, InternalVertex, SystemRelationType, Removable

public class BaseKey
extends BaseRelationType
implements PropertyKey

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

Modifier and Type	Field and Description
static BaseKey	SchemaCategory
static BaseKey	SchemaDefinitionDesc
static BaseKey	SchemaDefinitionProperty
static BaseKey	SchemaName
static BaseKey	SchemaUpdateTime
static BaseKey	VertexExists

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

DEFAULT_LABEL, EMPTY_ARGS

Method Summary

Modifier and Type	Method and Description
Cardinality	cardinality() The Cardinality of this property key.
Class<?>	dataType() Returns the data type for this property key.
Iterable<IndexType>	getKeyIndexes()
boolean	isEdgeLabel() Checks if this relation type is an edge label
boolean	isPropertyKey() Checks if this relation type is a property key
boolean	isUnidirected(org.apache.tinkerpop.gremlin.structure.Direction dir)
Multiplicity	multiplicity()

Methods inherited from class org.janusgraph.graphdb.types.system.BaseRelationType

getConsistencyModifier, hasId, isInvisibleType, longId, name, setId

Methods inherited from class org.janusgraph.graphdb.types.system.EmptyRelationType

getBaseType, getRelationIndexes, getSignature, getSortKey, getSortOrder, getStatus, getTTL, isInvisible, toString

Methods inherited from class org.janusgraph.graphdb.types.system.EmptyVertex

addEdge, addRelation, edges, getAddedRelations, getLifeCycle, hasAddedRelations, hasLoadedRelations, hasRemovedRelations, id, isLoaded, isModified, isNew, isRemoved, it, label, loadRelations, properties, property, property, query, remove, removeRelation, tx, value, valueOrNull, vertexLabel, vertices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface org.janusgraph.graphdb.internal.InternalRelationType

getBaseType, getRelationIndexes, getSignature, getSortKey, getSortOrder, getStatus, getTTL

Methods inherited from interface org.janusgraph.graphdb.internal.InternalVertex

addRelation, getAddedRelations, hasAddedRelations, hasLoadedRelations, hasRemovedRelations, it, loadRelations, query, removeRelation

Methods inherited from interface org.janusgraph.graphdb.internal.InternalElement

getLifeCycle, graph, isInvisible, tx

Field Detail

VertexExists

public static final BaseKey VertexExists

SchemaName

public static final BaseKey SchemaName

SchemaDefinitionProperty

public static final BaseKey SchemaDefinitionProperty

SchemaCategory

public static final BaseKey SchemaCategory

SchemaDefinitionDesc

public static final BaseKey SchemaDefinitionDesc

SchemaUpdateTime

public static final BaseKey SchemaUpdateTime

Method Detail

dataType

public Class<?> dataType()

Description copied from interface: PropertyKey

Returns the data type for this property key. The values of all properties of this type must be an instance of this data type.

Specified by:

dataType in interface PropertyKey

Returns:

Data type for this property key.

isPropertyKey

public final boolean isPropertyKey()

Description copied from interface: RelationType

Checks if this relation type is a property key

Specified by:

isPropertyKey in interface RelationType

Returns:

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

See Also:

PropertyKey

isEdgeLabel

public final boolean isEdgeLabel()

Description copied from interface: RelationType

Checks if this relation type is an edge label

Specified by:

isEdgeLabel in interface RelationType

Returns:

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

See Also:

EdgeLabel

multiplicity

public Multiplicity multiplicity()

Specified by:

multiplicity in interface InternalRelationType

isUnidirected

public boolean isUnidirected(org.apache.tinkerpop.gremlin.structure.Direction dir)

Specified by:

isUnidirected in interface InternalRelationType

cardinality

public Cardinality cardinality()

Description copied from interface: PropertyKey

The Cardinality of this property key.

Specified by:

cardinality in interface PropertyKey

Returns:

getKeyIndexes

public Iterable<IndexType> getKeyIndexes()

Specified by:

getKeyIndexes in interface InternalRelationType

Overrides:

getKeyIndexes in class EmptyRelationType