org.janusgraph.graphdb.database.indexing

Class StandardIndexInformation

java.lang.Object

org.janusgraph.graphdb.database.indexing.StandardIndexInformation

All Implemented Interfaces:

IndexInformation

public class StandardIndexInformation
extends Object
implements IndexInformation

Author:

Matthias Broecheler (me@matthiasb.com)

Field Summary

Fields

Modifier and Type	Field and Description
static StandardIndexInformation	INSTANCE

Method Summary

Modifier and Type	Method and Description
IndexFeatures	getFeatures() The features of this index
String	mapKey2Field(String key, KeyInformation information) Adjusts the name of the key so that it is a valid field name that can be used in the index.
boolean	supports(KeyInformation information) Whether the index supports indexing a key with the given information
boolean	supports(KeyInformation information, JanusGraphPredicate janusgraphPredicate) Whether the index supports executing queries with the given predicate against a key with the given information

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final StandardIndexInformation INSTANCE

Method Detail

supports

public boolean supports(KeyInformation information,
                        JanusGraphPredicate janusgraphPredicate)

Description copied from interface: IndexInformation

Whether the index supports executing queries with the given predicate against a key with the given information

Specified by:

supports in interface IndexInformation

Returns:

supports

public boolean supports(KeyInformation information)

Description copied from interface: IndexInformation

Whether the index supports indexing a key with the given information

Specified by:

supports in interface IndexInformation

Returns:

mapKey2Field

public String mapKey2Field(String key,
                           KeyInformation information)

Description copied from interface: IndexInformation

Adjusts the name of the key so that it is a valid field name that can be used in the index. JanusGraph stores this information and will use the returned name in all interactions with the index.

Note, that mapped field names (either configured on a per key basis or through a global configuration) are not adjusted and handed to the index verbatim.

Specified by:

mapKey2Field in interface IndexInformation

Returns:

getFeatures

public IndexFeatures getFeatures()

Description copied from interface: IndexInformation

The features of this index

Specified by:

getFeatures in interface IndexInformation

Returns: