oracle.pg.rdbms.index.oratext

Class OracleTextAutoIndex<T extends org.apache.tinkerpop.gremlin.structure.Element>

java.lang.Object

oracle.pg.rdbms.index.oratext.OracleTextAutoIndex<T>

All Implemented Interfaces:

OracleAutoIndex<T>, OracleIndex<T>

Direct Known Subclasses:

RDBMSOracleTextEdgeAutoIndex, RDBMSOracleTextVertexAutoIndex

public abstract class OracleTextAutoIndex<T extends org.apache.tinkerpop.gremlin.structure.Element>
extends java.lang.Object
implements OracleAutoIndex<T>

This class implements the OracleAutoIndex interface to handle text search and text indexing 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
OracleTextAutoIndex(java.lang.String indexName, java.lang.Class<T> indexClass, OraclePropertyGraphBase oraclePropertyGraph, Parameter[] indexParameters, boolean clear) Constructs a new OracleTextAutoIndex object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildSearchTerm(java.lang.String key, java.lang.Object value) Builds a search term query expression in the syntax required by this index.
java.lang.String	buildSearchTerm(java.lang.String key, java.lang.Object value, java.lang.Class dtClass) Builds a search term query expression in the syntax required by this index.
void	clearIndex() Clears all data stored in the text index.
void	close() Closes this index object.
boolean	containsIndexedKey(java.lang.String key) Verifies if the given key is already indexed using this automatic index.
long	count(java.lang.String key, java.lang.Object value) Counts all the matching elements that have a particular key/value property within the index
long	count(java.lang.String key, java.lang.Object value, boolean acceptWildcard) Counts all the matching elements that have a particular key/value property within the index
org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<T>	get(java.lang.String key, java.lang.Object value) Gets an Iterator object with all the matching elements that have a particular key/value property within the 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.lang.String	getGraphName() Get the name of the associated graph
java.lang.Class<T>	getIndexClass() Gets the class associated to this index
java.lang.String	getIndexName() Gets the name of this index instance.
OracleTextParameters	getIndexParameters() Gets the index parameters associated to this index.
OracleIndexParameters	getOracleIndexParameters() Gets the OracleIndexParameters associated to this index
Parameter<java.lang.String,java.lang.Object>[]	getParameters() Gets the Parameters associated to this index.
org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<T>[]	getPartitioned(java.lang.Object[] connections, java.lang.String key, java.lang.Object value, boolean acceptWildcard, int startShardId) Gets an array of CloseableIterator objects that hold all the elements with an attribute matching the given K/V pair.
OracleIndex.SEARCH_ENGINE	getSearchEngine() Gets the search engine used by this OracleIndex object
org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<T>	query(java.lang.String key, java.lang.Object value) Query for all the elements satisfying the specified K/V property within the index
org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<T>	query(java.lang.String key, java.lang.Object value, boolean useWildcards) Query for all the elements satisfying the specified K/V property within the index

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.pg.text.OracleAutoIndex

getIndexedKeys, indexElements, reindexElements, reindexElementsPartitioned

Methods inherited from interface oracle.pg.text.OracleIndex

add, commit, count, dropIndex, get, get, getDirectoryName, getDocIdentifier, getPartitioned, getPartitioned, getTotalShards, put, remove, remove, removeAll

Constructor Detail

OracleTextAutoIndex

public OracleTextAutoIndex(java.lang.String indexName,
                           java.lang.Class<T> indexClass,
                           OraclePropertyGraphBase oraclePropertyGraph,
                           Parameter[] indexParameters,
                           boolean clear)

Constructs a new OracleTextAutoIndex object.

Parameters:

indexName - the name of the index

indexClass - the element class that this index is indexing (can be base class)

oraclePropertyGraph - an OraclePropertyGraphBase object.

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

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

Method Detail

buildSearchTerm

public final java.lang.String buildSearchTerm(java.lang.String key,
                                              java.lang.Object value)

Builds a search term query expression in the syntax required by this index.

Specified by:

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

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

buildSearchTerm

public final java.lang.String buildSearchTerm(java.lang.String key,
                                              java.lang.Object value,
                                              java.lang.Class dtClass)

Builds a search term query expression in the syntax required by this index.

Specified by:

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

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

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

clearIndex

public void clearIndex()

Clears all data stored in the text index.

Specified by:

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

close

public void close()

Closes this index object. This operation will flush and commit all changes executed over the index and free up its underlying resources.

Specified by:

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

containsIndexedKey

public boolean containsIndexedKey(java.lang.String key)

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

Specified by:

containsIndexedKey in interface OracleAutoIndex<T extends org.apache.tinkerpop.gremlin.structure.Element>

Parameters:

key - the key to validate

Returns:

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

count

public final long count(java.lang.String key,
                        java.lang.Object value)

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

Specified by:

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

Returns:

a CloseableIterator object.

count

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

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

Specified by:

count 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. the index

Returns:

a CloseableIterator object.

get

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

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.

Returns:

a CloseableIterator object.

get

public final 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 OracleAutoIndex<T extends org.apache.tinkerpop.gremlin.structure.Element>

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

Returns:

a CloseableIterator object.

getGraphName

public final java.lang.String getGraphName()

Get the name of the associated graph

Specified by:

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

getIndexClass

public final java.lang.Class<T> getIndexClass()

Gets the class associated to this index

Specified by:

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

Returns:

Vertex.class if this is a vertex index or Edge.class if this is an Edge index.

getIndexName

public final java.lang.String getIndexName()

Gets the name of this index instance.

Specified by:

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

Returns:

the name of this index.

getIndexParameters

public OracleTextParameters getIndexParameters()

Gets the index parameters associated to this index.

Returns:

an OracleTextParameters object.

getOracleIndexParameters

public OracleIndexParameters getOracleIndexParameters()

Gets the OracleIndexParameters associated to this index

Specified by:

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

getParameters

public Parameter<java.lang.String,java.lang.Object>[] getParameters()

Gets the Parameters associated to this index.

Specified by:

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

Returns:

a Parameter array.

getPartitioned

public final org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<T>[] getPartitioned(java.lang.Object[] connections,
                                                                                               java.lang.String key,
                                                                                               java.lang.Object value,
                                                                                               boolean acceptWildcard,
                                                                                               int startShardId)

Gets an array of CloseableIterator objects that hold all the elements with an attribute matching the given K/V pair. Each element in the CloseableIterator array uses a separate connection provided to fetch a subset of the results from an Oracle Text index.

Specified by:

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

Parameters:

connections - an array of connections to the index. Each element of this array should be of type Oracle.

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.

startShardId - the ID of the starting shard.

Returns:

a CloseableIterator object.

getSearchEngine

public OracleIndex.SEARCH_ENGINE getSearchEngine()

Gets the search engine used by this OracleIndex object

Specified by:

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

query

public final org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<T> query(java.lang.String key,
                                                                                    java.lang.Object value)

Query for all the elements satisfying the specified K/V property within the index

Specified by:

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

Returns:

a CloseableIterator object.

query

public final org.apache.tinkerpop.gremlin.structure.util.CloseableIterator<T> query(java.lang.String key,
                                                                                    java.lang.Object value,
                                                                                    boolean useWildcards)

Query for all the elements satisfying the specified K/V property within the index

Specified by:

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

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

Returns:

a CloseableIterator object.