org.janusgraph.diskstorage.indexing

Interface IndexInformation

All Known Subinterfaces:

IndexProvider

All Known Implementing Classes:

MetricInstrumentedIndexProvider

public interface IndexInformation

An IndexInformation gives basic information on what a particular IndexProvider supports.

Author:

Matthias Broecheler (me@matthiasb.com)

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

Method Detail

supports

boolean supports(KeyInformation information,
                 JanusGraphPredicate janusgraphPredicate)

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

Parameters:

information -

janusgraphPredicate -

Returns:

supports

boolean supports(KeyInformation information)

Whether the index supports indexing a key with the given information

Parameters:

information -

Returns:

mapKey2Field

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

Parameters:

key -

information -

Returns:

getFeatures

IndexFeatures getFeatures()

The features of this index

Returns: