oracle.pg.rdbms.index.oratext

Class RDBMSOracleTextEdgeAutoIndex

java.lang.Object

oracle.pg.rdbms.index.oratext.OracleTextAutoIndex<org.apache.tinkerpop.gremlin.structure.Edge>

oracle.pg.rdbms.index.oratext.RDBMSOracleTextEdgeAutoIndex

All Implemented Interfaces:

OracleAutoIndex<org.apache.tinkerpop.gremlin.structure.Edge>, OracleIndex<org.apache.tinkerpop.gremlin.structure.Edge>

public class RDBMSOracleTextEdgeAutoIndex
extends OracleTextAutoIndex<org.apache.tinkerpop.gremlin.structure.Edge>

This class extends the functions defined in OracleTextAutoIndex to handle an automatic index on edges using Oracle Text.

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

Constructor Summary

Constructors

Constructor and Description
RDBMSOracleTextEdgeAutoIndex(java.lang.String indexName, OraclePropertyGraph opg, Parameter[] indexParameters, boolean erase) Constructs a new RDBMSOracleTextEdgeAutoIndex object.

Method Summary

Modifier and Type	Method and Description
long	count(java.lang.String key, java.lang.Object value, java.lang.Class dtClass, boolean acceptWildcard) Counts all the matching elements that have a particular key/value property within the index
void	dropIndex() Clears all data stored in the index.
java.lang.String	getDirectoryName() Gets the directory name for this index.
java.lang.String	getDocIdentifier() Get index document's identifier.
java.util.Set<java.lang.String>	getIndexedKeys() Gets a list of all the indexed keys used for this automatic index.
int	getPartitionsNumber() Gets the number of HASH partitions of the edges table for the associated property graph.
int	getTotalShards() Gets the number of partitions in this index.
void	reindexElements(java.lang.String key) Re-index the elements of the associated property graph based on the specified keys.

Methods inherited from class oracle.pg.rdbms.index.oratext.OracleTextAutoIndex

buildSearchTerm, buildSearchTerm, clearIndex, close, containsIndexedKey, count, count, getGraphName, getIndexClass, getIndexName, getIndexParameters, getOracleIndexParameters, getParameters, getSearchEngine

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.pg.text.OracleAutoIndex

get, indexElements, reindexElements, reindexElementsPartitioned

Methods inherited from interface oracle.pg.text.OracleIndex

add, commit, get, get, get, getPartitioned, getPartitioned, getPartitioned, put, query, query, remove, remove, removeAll

Constructor Detail

RDBMSOracleTextEdgeAutoIndex

public RDBMSOracleTextEdgeAutoIndex(java.lang.String indexName,
                                    OraclePropertyGraph opg,
                                    Parameter[] indexParameters,
                                    boolean erase)

Constructs a new RDBMSOracleTextEdgeAutoIndex object.

Parameters:

indexName - the name of the index

opg - an OraclePropertyGraph object.

indexParameters - a collection of parameters for the underlying index implementation.

erase - a boolean specifying if the index should be cleared at the beginning.

Method Detail

count

public long count(java.lang.String key,
                  java.lang.Object value,
                  java.lang.Class dtClass,
                  boolean acceptWildcard)

Counts all the matching elements that have a particular key/value property within the index

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 edges with the given key to be returned.

dtClass - the class representing the datatype of the property value. This can be used to cast the property value to a different datatype. For example, if the value is "3.01" and dtValue is Float.Class, then this value will be treated as a 3.01f.

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

Returns:

a CloseableIterator object.

dropIndex

public void dropIndex()

Clears all data stored in the index.

getDirectoryName

public java.lang.String getDirectoryName()

Gets the directory name for this index.

Returns:

the directory name for this index.

getDocIdentifier

public java.lang.String getDocIdentifier()

Get index document's identifier.

Returns:

a String representing the document's identifier based on the entity type it handles (edge or edge).

getIndexedKeys

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

Gets a list of all the indexed keys used for this automatic index.

Returns:

the set of keys used in this index.

getPartitionsNumber

public int getPartitionsNumber()

Gets the number of HASH partitions of the edges table for the associated property graph.

Returns:

the number of HASH partitions of the element's table.

getTotalShards

public int getTotalShards()

Gets the number of partitions in this index.

reindexElements

public final void reindexElements(java.lang.String key)

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

Parameters:

key - the key to use for re-indexing.