oracle.pg.text

Interface OracleAutoIndex<T extends org.apache.tinkerpop.gremlin.structure.Element>

All Superinterfaces:

OracleIndex<T>

All Known Implementing Classes:

OracleTextAutoIndex, RDBMSOracleTextEdgeAutoIndex, RDBMSOracleTextVertexAutoIndex

public interface OracleAutoIndex<T extends org.apache.tinkerpop.gremlin.structure.Element>
extends OracleIndex<T>

An interface that extends the functions defined in OracleIndex to provide manage an automatic index.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.pg.text.OracleIndex

OracleIndex.SEARCH_ENGINE

Field Summary

Fields inherited from interface oracle.pg.text.OracleIndex

EDGE_ID_PROP, EDGE_LABEL_PROP, END_NODE_ID_PROP, m_dtValues, START_NODE_ID_PROP, TYPE_DT_BOOL, TYPE_DT_BYTE, TYPE_DT_CHAR, TYPE_DT_DATE, TYPE_DT_DOUBLE, TYPE_DT_FLOAT, TYPE_DT_INTEGER, TYPE_DT_JSON, TYPE_DT_LONG, TYPE_DT_SERIALIZABLE, TYPE_DT_SHORT, TYPE_DT_SPATIAL, TYPE_DT_STRING, TYPE_DT_URI, VERTEX_ID_PROP, VERTEX_LABEL_PROP

Method Summary

Modifier and Type	Method and Description
boolean	containsIndexedKey(java.lang.String key) Verifies if the given key is already indexed using this automatic index.
org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<T>	get(java.lang.String key, java.lang.Object value, boolean acceptWildcard) Gets an Iterator object with all the matching elements that have a particular key/value property within the index
java.util.Set<java.lang.String>	getIndexedKeys() Get the keys associated to this auto index.
void	indexElements() Index elements in a property graph with respect to the current indexed keys.
void	reindexElements() Re-index the elements of the associated property graph based on the current indexed keys.
void	reindexElementsPartitioned() Re-index the elements of the associated property graph based on the current indexed keys using getElementsPartitioned APIs.

Methods inherited from interface oracle.pg.text.OracleIndex

add, buildSearchTerm, buildSearchTerm, clearIndex, close, commit, count, count, count, dropIndex, get, get, get, getDirectoryName, getDocIdentifier, getGraphName, getIndexClass, getIndexName, getOracleIndexParameters, getParameters, getPartitioned, getPartitioned, getPartitioned, getSearchEngine, getTotalShards, put, query, query, remove, remove, removeAll

Method Detail

containsIndexedKey

boolean containsIndexedKey(java.lang.String key)

Verifies if the given key is already indexed using this automatic index.

Parameters:

key - the key to validate

Returns:

true if the key is indexed in this automatic index, else false.

get

org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<T> get(java.lang.String key,
                                                                     java.lang.Object value,
                                                                     boolean acceptWildcard)

Gets an Iterator object with all the matching elements that have a particular key/value property within the index

Specified by:

get in interface OracleIndex<T extends org.apache.tinkerpop.gremlin.structure.Element>

Parameters:

key - the name of the property. It MUST not be NULL. If the key is not found in the index, the result will be 0.

value - the value object of the property. It can be NULL which will cause all elements with the given key to be returned.

acceptWildcard - specifies if wild cards can be used in the value object.

Returns:

a CloseableIterator object.

getIndexedKeys

java.util.Set<java.lang.String> getIndexedKeys()

Get the keys associated to this auto index.

Returns:

the set of keys used in this index.

indexElements

void indexElements()

Index elements in a property graph with respect to the current indexed keys.

reindexElements

void reindexElements()

Re-index the elements of the associated property graph based on the current indexed keys.

reindexElementsPartitioned

void reindexElementsPartitioned()

Re-index the elements of the associated property graph based on the current indexed keys using getElementsPartitioned APIs.