org.janusgraph.graphdb.database.management

Class JanusGraphIndexWrapper

java.lang.Object

org.janusgraph.graphdb.database.management.JanusGraphIndexWrapper

All Implemented Interfaces:

Namifiable, Index, JanusGraphIndex, JanusGraphSchemaElement

public class JanusGraphIndexWrapper
extends Object
implements JanusGraphIndex

Author:

Matthias Broecheler (me@matthiasb.com)

Constructor Summary

Constructors

Constructor and Description
JanusGraphIndexWrapper(IndexType index)

Method Summary

Modifier and Type	Method and Description
String	getBackingIndex() Returns the name of the backing index.
PropertyKey[]	getFieldKeys() Returns the indexed keys of this index.
Class<? extends org.apache.tinkerpop.gremlin.structure.Element>	getIndexedElement() Returns which element type is being indexed by this index (vertex, edge, or property)
SchemaStatus	getIndexStatus(PropertyKey key) Returns the status of this index with respect to the provided PropertyKey.
Parameter[]	getParametersFor(PropertyKey key) Returns the parameters associated with an indexed key of this index.
JanusGraphSchemaType	getSchemaTypeConstraint()
Object	id() Returns a unique identifier for this entity.
boolean	isCompositeIndex() Whether this is a composite index
boolean	isMixedIndex() Whether this is a mixed index
boolean	isUnique() Whether this is a unique index, i.e.
long	longId() Unique identifier for this entity.
String	name() Returns the name of the index
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JanusGraphIndexWrapper

public JanusGraphIndexWrapper(IndexType index)

Method Detail

id

public Object id()

Description copied from interface: JanusGraphIndex

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 JanusGraphIndex

Returns:

The unique identifier for this entity

longId

public long longId()

Description copied from interface: JanusGraphIndex

Unique identifier for this entity. This id can be temporarily assigned and might change. Use JanusGraphIndex.id() for the permanent id.

Specified by:

longId in interface JanusGraphIndex

Returns:

Unique long id

name

public String name()

Description copied from interface: JanusGraphIndex

Returns the name of the index

Specified by:

name in interface Namifiable

Specified by:

name in interface JanusGraphIndex

Returns:

Name of this entity.

getBackingIndex

public String getBackingIndex()

Description copied from interface: JanusGraphIndex

Returns the name of the backing index. For composite indexes this returns a default name. For mixed indexes, this returns the name of the configured indexing backend.

Specified by:

getBackingIndex in interface JanusGraphIndex

Returns:

getIndexedElement

public Class<? extends org.apache.tinkerpop.gremlin.structure.Element> getIndexedElement()

Description copied from interface: JanusGraphIndex

Returns which element type is being indexed by this index (vertex, edge, or property)

Specified by:

getIndexedElement in interface JanusGraphIndex

Returns:

getFieldKeys

public PropertyKey[] getFieldKeys()

Description copied from interface: JanusGraphIndex

Returns the indexed keys of this index. If the returned array contains more than one element, its a composite index.

Specified by:

getFieldKeys in interface JanusGraphIndex

Returns:

getParametersFor

public Parameter[] getParametersFor(PropertyKey key)

Description copied from interface: JanusGraphIndex

Returns the parameters associated with an indexed key of this index. Parameters modify the indexing behavior of the underlying indexing backend.

Specified by:

getParametersFor in interface JanusGraphIndex

Returns:

isUnique

public boolean isUnique()

Description copied from interface: JanusGraphIndex

Whether this is a unique index, i.e. values are uniquely associated with at most one element in the graph (for a particular type)

Specified by:

isUnique in interface JanusGraphIndex

Returns:

getIndexStatus

public SchemaStatus getIndexStatus(PropertyKey key)

Description copied from interface: JanusGraphIndex

Returns the status of this index with respect to the provided PropertyKey. For composite indexes, the key is ignored and the status of the index as a whole is returned. For mixed indexes, the status of that particular key within the index is returned.

Specified by:

getIndexStatus in interface JanusGraphIndex

Returns:

isCompositeIndex

public boolean isCompositeIndex()

Description copied from interface: JanusGraphIndex

Whether this is a composite index

Specified by:

isCompositeIndex in interface JanusGraphIndex

Returns:

isMixedIndex

public boolean isMixedIndex()

Description copied from interface: JanusGraphIndex

Whether this is a mixed index

Specified by:

isMixedIndex in interface JanusGraphIndex

Returns:

getSchemaTypeConstraint

public JanusGraphSchemaType getSchemaTypeConstraint()

Specified by:

getSchemaTypeConstraint in interface JanusGraphIndex

toString

public String toString()

Overrides:

toString in class Object