oracle.pg.rdbms.index.oratext

Class RDBMSOracleTextEdgeAutoIndex

java.lang.Object

oracle.pg.rdbms.index.oratext.OracleTextAutoIndex<com.tinkerpop.blueprints.Edge>

oracle.pg.rdbms.index.oratext.RDBMSOracleTextEdgeAutoIndex

All Implemented Interfaces:

com.tinkerpop.blueprints.Index<com.tinkerpop.blueprints.Edge>, OracleAutoIndex<com.tinkerpop.blueprints.Edge>, OracleIndex<com.tinkerpop.blueprints.Edge>

public class RDBMSOracleTextEdgeAutoIndex
extends OracleTextAutoIndex<com.tinkerpop.blueprints.Edge>

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

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

Constructor Summary

Constructors

Constructor and Description
RDBMSOracleTextEdgeAutoIndex(java.lang.String indexName, OraclePropertyGraph opg, com.tinkerpop.blueprints.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.
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Edge>	get(java.lang.Object query) Gets an Iterable object with all the matching elements that match the given query object
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Edge>	get(java.lang.String key, java.lang.Object value, java.lang.Class dtValue, boolean acceptWildcard) Gets all edges indexed by the provided key/value.
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.
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Edge>[]	getPartitioned(java.lang.Object[] connections, java.lang.Object query, int iStartPartitionId) Gets an array of CloseableIterable objects that hold all the edges with an attribute matching the Query object.
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Edge>[]	getPartitioned(java.lang.Object[] connections, java.lang.String key, java.lang.Object value, java.lang.Class dtValue, boolean acceptWildcard, int iStartPartitionId) Gets an array of CloseableIterable objects that hold all the edges with an attribute matching the Query object.
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, get, get, getGraphName, getIndexClass, getIndexName, getIndexParameters, getOracleIndexParameters, getParameters, getPartitioned, query, query

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.pg.text.OracleAutoIndex

indexElements, reindexElements, reindexElementsPartitioned

Methods inherited from interface oracle.pg.text.OracleIndex

add, commit, remove, removeAll

Methods inherited from interface com.tinkerpop.blueprints.Index

put, remove

Constructor Detail

RDBMSOracleTextEdgeAutoIndex

public RDBMSOracleTextEdgeAutoIndex(java.lang.String indexName,
                                    OraclePropertyGraph opg,
                                    com.tinkerpop.blueprints.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 CloseableIterable object.

dropIndex

public void dropIndex()

Clears all data stored in the index.

get

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Edge> get(java.lang.Object query)

Gets an Iterable object with all the matching elements that match the given query object

Parameters:

query - a OracleTextQueryObject object.

Returns:

a CloseableIterable object.

get

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Edge> get(java.lang.String key,
                                                                                     java.lang.Object value,
                                                                                     java.lang.Class dtValue,
                                                                                     boolean acceptWildcard)

Gets all edges indexed by the provided key/value.

Parameters:

key - the key of the indexed edges.

value - the value of the indexed edges.

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

Returns:

an iterable of edges that have a particular key/value 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.

getPartitioned

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Edge>[] getPartitioned(java.lang.Object[] connections,
                                                                                                  java.lang.Object query,
                                                                                                  int iStartPartitionId)

Gets an array of CloseableIterable objects that hold all the edges with an attribute matching the Query object. Each edge in the CloseableIterable array uses a separate connection provided to fetch a subset of the results from a table partition. Note that we assign an integer ID (in the range of [0, N - 1]) to all the partitions in a table with N partitions. The subset of partitions queried will consist of those partitions with ID value in the range of [iStartPartitionId, iStartPartitionId - 1 + size of connections array].

Parameters:

connections - an array of Connection connections to the Oracle Database where the Oracle Text relies.

query - a OracleTextQueryObject object.

iStartPartitionId - the ID of the starting partition.

Returns:

a CloseableIterable object.

getPartitioned

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Edge>[] getPartitioned(java.lang.Object[] connections,
                                                                                                  java.lang.String key,
                                                                                                  java.lang.Object value,
                                                                                                  java.lang.Class dtValue,
                                                                                                  boolean acceptWildcard,
                                                                                                  int iStartPartitionId)

Gets an array of CloseableIterable objects that hold all the edges with an attribute matching the Query object. Each edge in the CloseableIterable array uses a separate connection provided to fetch a subset of the results from a table partition. Note that we assign an integer ID (in the range of [0, N - 1]) to all the partitions in a table with N partitions. The subset of partitions queried will consist of those partitions with ID value in the range of [iStartPartitionId, iStartPartitionId - 1 + size of connections array].

Parameters:

connections - an array of Connection connections to the Oracle Database where the Oracle Text relies.

key - the key of a property

value - the value object of the property.

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

iStartPartitionId - the ID of the starting partition.

dtValue - 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 dtClass is Float.Class, then this value will be treated as a 3.01f.

Returns:

a CloseableIterable object.

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.