org.janusgraph.graphdb.types.system

Class ImplicitKey

java.lang.Object

org.janusgraph.graphdb.types.system.EmptyVertex

org.janusgraph.graphdb.types.system.EmptyRelationType

org.janusgraph.graphdb.types.system.ImplicitKey

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 ImplicitKey
extends EmptyRelationType
implements SystemRelationType, PropertyKey

Author:

Matthias Broecheler (me@matthiasb.com)

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 ImplicitKey	ADJACENT_ID
static ImplicitKey	ID
static ImplicitKey	JANUSGRAPHID
static ImplicitKey	KEY
static ImplicitKey	LABEL
static Map<EntryMetaData,ImplicitKey>	MetaData2ImplicitKey
static ImplicitKey	TIMESTAMP
static ImplicitKey	TTL
static ImplicitKey	VALUE
static ImplicitKey	VISIBILITY

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.
<O> O	computeProperty(InternalElement e)
Class<?>	dataType() Returns the data type for this property key.
ConsistencyModifier	getConsistencyModifier()
boolean	hasId() Checks whether this entity has a unique identifier.
Object	id() Returns a unique identifier for this entity.
boolean	isEdgeLabel() Checks if this relation type is an edge label
boolean	isInvisibleType()
boolean	isPropertyKey() Checks if this relation type is a property key
boolean	isUnidirected(org.apache.tinkerpop.gremlin.structure.Direction dir)
Multiplicity	multiplicity()
String	name() Returns the unique name of this entity.
void	setId(Object id)
String	toString()

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

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

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

addEdge, addRelation, edges, findAddedProperty, findPreviousRelation, getAddedRelations, getLifeCycle, hasAddedRelations, hasLoadedRelations, hasRemovedRelations, 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.graphdb.internal.InternalRelationType

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

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

isNew, longId

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

addRelation, findAddedProperty, findPreviousRelation, getAddedRelations, getDuplicatedAddedRelation, hasAddedRelations, hasLoadedRelations, hasRemovedRelations, it, loadRelations, query, removeRelation

Methods inherited from interface org.janusgraph.core.JanusGraphVertex

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

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

edges, properties, property, vertices

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

getHostingVertex

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

getLifeCycle, graph, isInvisible, tx

Methods inherited from interface org.janusgraph.core.JanusGraphElement

isLoaded, isNew, isRemoved, remove, valueOrNull

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

keys, value, values

Field Detail

ID

public static final ImplicitKey ID

JANUSGRAPHID

public static final ImplicitKey JANUSGRAPHID

LABEL

public static final ImplicitKey LABEL

KEY

public static final ImplicitKey KEY

VALUE

public static final ImplicitKey VALUE

ADJACENT_ID

public static final ImplicitKey ADJACENT_ID

TIMESTAMP

public static final ImplicitKey TIMESTAMP

VISIBILITY

public static final ImplicitKey VISIBILITY

TTL

public static final ImplicitKey TTL

MetaData2ImplicitKey

public static final Map<EntryMetaData,ImplicitKey> MetaData2ImplicitKey

Method Detail

computeProperty

public <O> O computeProperty(InternalElement e)

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.

cardinality

public Cardinality cardinality()

Description copied from interface: PropertyKey

The Cardinality of this property key.

Specified by:

cardinality in interface PropertyKey

Returns:

name

public String name()

Description copied from interface: Namifiable

Returns the unique name of this entity.

Specified by:

name in interface Namifiable

Returns:

Name of this entity.

isPropertyKey

public 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 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

isInvisibleType

public boolean isInvisibleType()

Specified by:

isInvisibleType in interface InternalRelationType

multiplicity

public Multiplicity multiplicity()

Specified by:

multiplicity in interface InternalRelationType

getConsistencyModifier

public ConsistencyModifier getConsistencyModifier()

Specified by:

getConsistencyModifier in interface InternalRelationType

isUnidirected

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

Specified by:

isUnidirected in interface InternalRelationType

id

public Object id()

Description copied from interface: JanusGraphElement

Returns a unique identifier for this entity.

The unique identifier may only be set when the transaction in which entity is created commits. Some entities are never assigned a unique identifier if they depend on a parent entity.

JanusGraph allocates blocks of identifiers and automatically assigns identifiers to elements automatically be default. This behavior can be partially overridden by setting GraphDatabaseConfiguration.ALLOW_SETTING_VERTEX_ID

Specified by:

id in interface org.apache.tinkerpop.gremlin.structure.Element

Specified by:

id in interface Idfiable

Specified by:

id in interface JanusGraphElement

Overrides:

id in class EmptyVertex

Returns:

The unique identifier for this entity

See Also:

JanusGraphElement.hasId()

hasId

public boolean hasId()

Description copied from interface: JanusGraphElement

Checks whether this entity has a unique identifier.

Note that some entities may never be assigned an identifier and others will only be assigned an identifier at the end of a transaction.

Specified by:

hasId in interface JanusGraphElement

Overrides:

hasId in class EmptyVertex

Returns:

true if this entity has been assigned a unique id, else false

setId

public void setId(Object id)

Specified by:

setId in interface InternalElement

Overrides:

setId in class EmptyVertex

toString

public String toString()

Overrides:

toString in class EmptyRelationType