oracle.pg.text.lucene

Class LuceneAutoIndex<T extends Element>

java.lang.Object

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

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

All Implemented Interfaces:

Index<T>, OracleAutoIndex<T>, OracleIndex<T>

Direct Known Subclasses:

LuceneEdgeAutoIndex, LuceneVertexAutoIndex

public abstract class LuceneAutoIndex<T extends 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, START_NODE_ID_PROP, TYPE_DT_BOOL, TYPE_DT_DATE, TYPE_DT_DOUBLE, TYPE_DT_FLOAT, TYPE_DT_INTEGER, TYPE_DT_SERIALIZABLE, TYPE_DT_STRING, VERTEX_ID_PROP

Constructor Summary

Constructors

Constructor and Description
LuceneAutoIndex(String indexName, Class<T> indexClass, OraclePropertyGraphBase graph, Parameter<String,Object>[] indexParameters, boolean erase) Constructs a new LuceneAutoIndex object.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this OracleIndex object
abstract void	closeConnectionsArray() Closes the associated connection array used to load vertices/edges in parallel from the underlying graph.
boolean	containsIndexedKey(String key) Verifies if the given key is already indexed using this automatic index.
abstract Object[]	getConnectionsArray() Gets the connection array used to load vertices/edges in parallel from the underlying graph.
abstract Iterable<T>	getElementsFromPG() Gets an Iterable<T> of elements from the associated property graph.
abstract Iterable<T>	getElementsFromPG(String key) Gets an Iterable<T> of elements from the associated property graph, matching the specified key.
abstract Iterable<T>	getElementsFromPG(String[] keys) Gets an Iterable<T> of elements from the associated property graph, matching any of the specified keys.
abstract Iterable<T>[]	getElementsFromPG(String[] keys, Object[] conns, int startSplitID) Gets an array of CloseableIterable objects that hold all the elements with an attribute matching any of the given key property names.
Set<String>	getIndexedKeys() Get the keys associated to this auto index.
abstract int	getPartitionsNumber() Gets the number of partitions (or splits) of the element's table for the associated property graph.
void	indexElements() Index elements in a property graph with respect to the current indexed keys.
void	indexElementsPartitioned() Index elements in a property graph with respect to the current indexed keys using getElementsPartitioned APIs.
List<String>	loadIndexedKeys() Gets a list of all the indexed keys used for this automatic index.
void	put(String key, Object value, T element) Indexes an element with respect to the specified key and value.
void	put(String key, 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	reindexElements(String key) Re-index the elements of the associated property graph based on the specified key.
void	reindexElements(String[] indexedKeys) Re-index the elements of the associated property graph based on the specified keys using getElementsPartitioned APIs.
void	reindexElementsNoPartitioned(String[] indexedKeys) Re-index the elements of the associated property graph based on the specified keys.
void	reindexElementsPartitioned() Re-index the elements of the associated property graph based on the current indexed keys using getElementsPartitioned APIs.
void	reindexElementsPartitioned(String key) Re-index the elements of the associated property graph based on the specified key using getElementsPartitioned APIs.
void	reindexElementsPartitioned(String[] indexedKeys) Re-index all elements over a partitioned graph.

Methods inherited from class oracle.pg.text.lucene.LuceneIndex

add, addToDeleteCache, buildSearchTerm, buildSearchTerm, clearIndex, commit, count, count, count, deleteExistingDirectories, dropIndex, get, get, get, getDirectory, getDirectoryName, getDocIdentifier, getGraphName, getIndexClass, getIndexName, getIndexParameters, getOracleDirectory, getOracleIndexParameters, getOracleSearcherManager, getParameters, getPartitioned, getPartitioned, getSearcherFactory, getTotalShards, isAutoIndex, isDelBatchEmpty, isDelBatchFull, isUpdatesBatchEmpty, isUpdatesBatchFull, 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, getDirectoryName, getDocIdentifier, getGraphName, getIndexClass, getOracleIndexParameters, getParameters, getPartitioned, getPartitioned, getTotalShards, isDelBatchEmpty, isDelBatchFull, isUpdatesBatchEmpty, isUpdatesBatchFull, query, refreshIndex, remove, removeAll

Methods inherited from interface com.tinkerpop.blueprints.Index

count, get, getIndexName, query, remove

Constructor Detail

LuceneAutoIndex

public LuceneAutoIndex(String indexName,
               Class<T> indexClass,
               OraclePropertyGraphBase graph,
               Parameter<String,Object>[] indexParameters,
               boolean erase)

Constructs a new LuceneAutoIndex object.

Parameters:

indexName - the name of the index.

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

graph - an OraclePropertyGraphBase 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

close

public void close()

Closes this OracleIndex object

Specified by:

close in interface OracleIndex<T extends Element>

Overrides:

close in class LuceneIndex<T extends Element>

closeConnectionsArray

public abstract void closeConnectionsArray()

Closes the associated connection array used to load vertices/edges in parallel from the underlying graph.

Specified by:

closeConnectionsArray in interface OracleAutoIndex<T extends Element>

containsIndexedKey

public boolean containsIndexedKey(String key)

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

Specified by:

containsIndexedKey in interface OracleAutoIndex<T extends Element>

getConnectionsArray

public abstract Object[] getConnectionsArray()
                                      throws Exception

Gets the connection array used to load vertices/edges in parallel from the underlying graph.

Specified by:

getConnectionsArray in interface OracleAutoIndex<T extends Element>

Returns:

an array of connections to the database where the property graph instance relies.

Throws:

Exception

getElementsFromPG

public abstract Iterable<T> getElementsFromPG()

Gets an Iterable<T> of elements from the associated property graph.

Specified by:

getElementsFromPG in interface OracleAutoIndex<T extends Element>

Returns:

an Iterable<T> object.

getElementsFromPG

public abstract Iterable<T> getElementsFromPG(String key)

Gets an Iterable<T> of elements from the associated property graph, matching the specified key.

Specified by:

getElementsFromPG in interface OracleAutoIndex<T extends Element>

Parameters:

key - name of the property. It can be NULL which implies all vertices in the graph will be returned.

Returns:

an Iterable<T> object.

getElementsFromPG

public abstract Iterable<T> getElementsFromPG(String[] keys)

Gets an Iterable<T> of elements from the associated property graph, matching any of the specified keys.

Specified by:

getElementsFromPG in interface OracleAutoIndex<T extends Element>

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

Returns:

an Iterable<T> object.

getElementsFromPG

public abstract Iterable<T>[] getElementsFromPG(String[] keys,
                              Object[] conns,
                              int startSplitID)

Gets an array of CloseableIterable objects that hold all the elements with an attribute matching any of the given key property names. Each element in the CloseableIterable array uses a separate connection provided to fetch a subset of the results from a corresponding OraclePropertyGraph instance. Note that we assign an integer ID (in the range of [0, N - 1]) to all the splits of a vertex or edge table with N splits. The subset of splits queried will consist of those shards with ID value in the range of [startSplitID, startSplitID - 1 + size of connections array].

Specified by:

getElementsFromPG in interface OracleAutoIndex<T extends Element>

Parameters:

keys - an array of property key names. It can be NULL which implies all vertices in the graph will be returned.

conns - an array of Object connections to the database where the property graph relies.

startSplitID - the start split ID used to query the property graph.

Returns:

an Iterable<T> object.

getIndexedKeys

public final Set<String> getIndexedKeys()

Get the keys associated to this auto index.

Specified by:

getIndexedKeys in interface OracleAutoIndex<T extends Element>

Returns:

the set of keys used in this index.

getPartitionsNumber

public abstract int getPartitionsNumber()

Gets the number of partitions (or splits) of the element's table for the associated property graph.

Specified by:

getPartitionsNumber in interface OracleAutoIndex<T extends Element>

Returns:

the number of partitions (or splits) of the element's table.

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 Element>

indexElementsPartitioned

public final void indexElementsPartitioned()

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

Specified by:

indexElementsPartitioned in interface OracleAutoIndex<T extends Element>

loadIndexedKeys

public List<String> loadIndexedKeys()

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

Specified by:

loadIndexedKeys in interface OracleAutoIndex<T extends Element>

put

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

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

Specified by:

put in interface Index<T extends Element>

Overrides:

put in class LuceneIndex<T extends 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(String key,
       Object value,
       T element,
       OracleIndexWriter[] indexWriters)

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

Overrides:

put in class LuceneIndex<T extends 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 Element>

reindexElements

public void reindexElements(String key)

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

Specified by:

reindexElements in interface OracleAutoIndex<T extends Element>

Parameters:

key - the key to use for re-indexing.

reindexElements

public void reindexElements(String[] indexedKeys)

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

Specified by:

reindexElements in interface OracleAutoIndex<T extends Element>

Parameters:

indexedKeys - an array of the indexed keys to use for re-indexing.

reindexElementsNoPartitioned

public void reindexElementsNoPartitioned(String[] indexedKeys)

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

Specified by:

reindexElementsNoPartitioned in interface OracleAutoIndex<T extends Element>

Parameters:

indexedKeys - an array of the indexed keys to use for re-indexing.

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 Element>

reindexElementsPartitioned

public void reindexElementsPartitioned(String key)

Re-index the elements of the associated property graph based on the specified key using getElementsPartitioned APIs.

Specified by:

reindexElementsPartitioned in interface OracleAutoIndex<T extends Element>

Parameters:

key - the key to use for re-indexing.

reindexElementsPartitioned

public void reindexElementsPartitioned(String[] indexedKeys)

Re-index all elements over a partitioned graph.

Specified by:

reindexElementsPartitioned in interface OracleAutoIndex<T extends Element>

Parameters:

indexedKeys - an array of keys to be indexed