oracle.pg.text.lucene

Class LuceneAutoIndex<T extends com.tinkerpop.blueprints.Element>

java.lang.Object

oracle.pg.text.lucene.LuceneIndex<T>

oracle.pg.text.lucene.LuceneAutoIndex<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

LuceneEdgeAutoIndex, LuceneVertexAutoIndex

public abstract class LuceneAutoIndex<T extends com.tinkerpop.blueprints.Element>
extends LuceneIndex<T>
implements OracleAutoIndex<T>

This class extends LuceneIndex implements the OracleAutoIndex interface to handle text search and text indexing using Apache Lucene.

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

Method Summary

Modifier and Type	Method and Description
void	close() Closes this index object.
boolean	containsIndexedKey(java.lang.String key) Verifies if the given key is already indexed using this automatic 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	put(java.lang.String key, java.lang.Object value, T element) Indexes an element with respect to the specified key and value.
void	put(java.lang.String key, java.lang.Object value, T element, OracleIndexWriter[] indexWriters) Indexes an element with respect to the specified key and value.
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 class oracle.pg.text.lucene.LuceneIndex

add, appendDatatypesSuffixToKey, appendDatatypesSuffixToValue, buildSearchTerm, buildSearchTerm, buildSearchTermObject, clearIndex, commit, count, count, count, dropIndex, get, get, get, get, getDirectory, getDirectoryName, getDocIdentifier, getGraphName, getIndexClass, getIndexName, getIndexParameters, getOracleDirectory, getOracleIndexParameters, getOracleSearcherManager, getOracleSearcherManager, getParameters, getPartitioned, getPartitioned, getPartitioned, getSearcherFactory, getTotalShards, isAutoIndex, query, query, remove, remove, remove, remove, removeAll, removeAll

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

Methods inherited from interface oracle.pg.text.OracleIndex

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

Methods inherited from interface com.tinkerpop.blueprints.Index

count, get, getIndexName, query, remove

Method Detail

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 com.tinkerpop.blueprints.Element>

Overrides:

close in class LuceneIndex<T extends com.tinkerpop.blueprints.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 com.tinkerpop.blueprints.Element>

Parameters:

key - the key to validate

Returns:

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

getIndexedKeys

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

Get the keys associated to this auto index.

Specified by:

getIndexedKeys in interface OracleAutoIndex<T extends com.tinkerpop.blueprints.Element>

Returns:

the set of keys used in this index.

indexElements

public final void indexElements()

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

Specified by:

indexElements in interface OracleAutoIndex<T extends com.tinkerpop.blueprints.Element>

put

public final void put(java.lang.String key,
                      java.lang.Object value,
                      T element)

Indexes an element with respect to the specified key and value.

Specified by:

put in interface com.tinkerpop.blueprints.Index<T extends com.tinkerpop.blueprints.Element>

Overrides:

put in class LuceneIndex<T extends com.tinkerpop.blueprints.Element>

Parameters:

key - the key to index the element by.

value - the value to index the element by.

element - the element to index.

put

public final void put(java.lang.String key,
                      java.lang.Object value,
                      T element,
                      OracleIndexWriter[] indexWriters)

Indexes an element with respect to the specified key and value. Using an array of OracleIndexWriter for all the sub-directories in the text index reduce the number of open/commit/close operations to Apache Lucene. The user is responsible of calling the commit operation on each index writer so the changes executed by this operation are persisted into the text index.

Overrides:

put in class LuceneIndex<T extends com.tinkerpop.blueprints.Element>

Parameters:

key - the key to index the element by.

value - the value to index the element by.

element - the element to index.

indexWriters - if not null, the cache of indexWriters to use, this avoids opening/closing index writers at flush time, but locks writing operations over the index.

reindexElements

public void reindexElements()

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

Specified by:

reindexElements in interface OracleAutoIndex<T extends com.tinkerpop.blueprints.Element>

reindexElementsPartitioned

public void reindexElementsPartitioned()

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

Specified by:

reindexElementsPartitioned in interface OracleAutoIndex<T extends com.tinkerpop.blueprints.Element>