public interface KeyInformation
So, given a key, its associated KeyInformation provides the details on what data type the key's associated values have and whether this key has been configured with any additional parameters (that might provide information on how the key should be indexed).
KeyInformation.IndexRetriever
returns KeyInformation
for a given store and given key. This will be provided to an
index when the key is not fixed in the context, e.g. in IndexProvider#mutate(java.util.Map, IndexRetriever, org.janusgraph.diskstorage.BaseTransaction)
KeyInformation.Retriever
returns KeyInformation.IndexRetriever
for a given index identified by its name. This is only used
internally to pass KeyInformation.IndexRetriever
s around.
Modifier and Type | Interface and Description |
---|---|
static interface |
KeyInformation.IndexRetriever |
static interface |
KeyInformation.Retriever |
static interface |
KeyInformation.StoreRetriever |
Modifier and Type | Method and Description |
---|---|
Cardinality |
getCardinality()
Returns the
Cardinality for this key. |
Class<?> |
getDataType()
Returns the data type of the key's values.
|
Parameter[] |
getParameters()
Returns the parameters of the key's configuration.
|
Class<?> getDataType()
Parameter[] getParameters()
Cardinality getCardinality()
Cardinality
for this key.Copyright © 2012–2023. All rights reserved.