oracle.pg.text.lucene

Class LuceneVertexAutoIndex

java.lang.Object

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

oracle.pg.text.lucene.LuceneAutoIndex<com.tinkerpop.blueprints.Vertex>

oracle.pg.text.lucene.LuceneVertexAutoIndex

All Implemented Interfaces:

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

Direct Known Subclasses:

HBaseLuceneVertexAutoIndex

public abstract class LuceneVertexAutoIndex
extends LuceneAutoIndex<com.tinkerpop.blueprints.Vertex>
implements OracleAutoIndex<com.tinkerpop.blueprints.Vertex>

This class extends the functions defined in LuceneAutoIndex to handle an automatic index on vertices.

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
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>	get(Object query) Gets an Iterable object with all the matching elements that match the given query object.
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>	get(String key, Object value, Class dtClass, boolean acceptWildcard) Gets all vertices indexed by the provided key/value.
String	getDocIdentifier() Gets the document's identifier associated to this index.
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>[]	getPartitioned(Object[] connections, Object query, int startShardId) Gets an array of CloseableIterable objects that hold all the vertices with an attribute matching the Query object.
com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>[]	getPartitioned(Object[] connections, String key, Object value, Class dtClass, boolean acceptWildcard, int startShardId) Gets an array of CloseableIterable objects that hold all the elements with an attribute matching the given K/V pair.

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

close, containsIndexedKey, getIndexedKeys, indexElements, put, put, reindexElements, reindexElementsPartitioned

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

add, appendDatatypesSuffixToKey, appendDatatypesSuffixToValue, buildSearchTerm, buildSearchTerm, buildSearchTermObject, clearIndex, commit, count, count, count, dropIndex, get, get, getDirectory, getDirectoryName, getGraphName, getIndexClass, getIndexName, getIndexParameters, getOracleDirectory, getOracleIndexParameters, getOracleSearcherManager, getOracleSearcherManager, getParameters, 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

containsIndexedKey, get, getIndexedKeys, indexElements, reindexElements, reindexElementsPartitioned

Methods inherited from interface oracle.pg.text.OracleIndex

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

Methods inherited from interface com.tinkerpop.blueprints.Index

count, get, getIndexName, put, query, remove

Method Detail

get

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex> get(Object query)

Gets an Iterable object with all the matching elements that match the given query object. This object can be either a String text search query, or a Lucene Query object.

Specified by:

get in interface OracleIndex<com.tinkerpop.blueprints.Vertex>

Specified by:

get in class LuceneIndex<com.tinkerpop.blueprints.Vertex>

Parameters:

query - a object representing the text query to execute.

Returns:

a CloseableIterable object.

get

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex> get(String key,
                                                                                       Object value,
                                                                                       Class dtClass,
                                                                                       boolean acceptWildcard)

Gets all vertices indexed by the provided key/value.

Specified by:

get in interface OracleIndex<com.tinkerpop.blueprints.Vertex>

Specified by:

get in class LuceneIndex<com.tinkerpop.blueprints.Vertex>

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.

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.

Returns:

an iterable of elements that have a particular key/value in the index.

getDocIdentifier

public String getDocIdentifier()

Gets the document's identifier associated to this index.

Specified by:

getDocIdentifier in interface OracleIndex<com.tinkerpop.blueprints.Vertex>

Overrides:

getDocIdentifier in class LuceneIndex<com.tinkerpop.blueprints.Vertex>

Returns:

the document's identifier associated to this index.

getPartitioned

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>[] getPartitioned(Object[] connections,
                                                                                                    Object query,
                                                                                                    int startShardId)

Gets an array of CloseableIterable objects that hold all the vertices with an attribute matching the Query object. This object can be either a String text search query, or a Lucene Query object. Each vertex in the CloseableIterable array uses a separate connection provided to fetch a subset of the results from a corresponding Lucene sub-directory. Note that we assign an integer ID (in the range of [0, N - 1]) to all the sub-directories in a Lucene index with N shards. The subset of shards (subdirectories) queried will consist of those shards with ID value in the range of [startShardId, startShardId - 1 + size of connections array].

Specified by:

getPartitioned in interface OracleIndex<com.tinkerpop.blueprints.Vertex>

Specified by:

getPartitioned in class LuceneIndex<com.tinkerpop.blueprints.Vertex>

Parameters:

connections - an array of connections to the Lucene index Each vertex of this array should be of type SearcherManager. See LuceneIndex.getOracleSearcherManager(int).

query - a a object representing the text query to execute.

startShardId - the ID of the starting shard.

Returns:

a CloseableIterable object.

getPartitioned

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>[] getPartitioned(Object[] connections,
                                                                                                    String key,
                                                                                                    Object value,
                                                                                                    Class dtClass,
                                                                                                    boolean acceptWildcard,
                                                                                                    int startShardId)

Gets an array of CloseableIterable objects that hold all the elements with an attribute matching the given K/V pair. Each vertex in the CloseableIterable array uses a separate connection provided to fetch a subset of the results from a corresponding Lucene sub-directory. Note that we assign an integer ID (in the range of [0, N - 1]) to all the sub-directories in a Lucene index with N shards. The subset of shards (subdirectories) queried will consist of those shards with ID value in the range of [startShardId, startShardId - 1 + size of connections array].

Specified by:

getPartitioned in interface OracleIndex<com.tinkerpop.blueprints.Vertex>

Specified by:

getPartitioned in class LuceneIndex<com.tinkerpop.blueprints.Vertex>

Parameters:

connections - an array of connections to the Lucene index. Each vertex of this array should be of type SearcherManager. See LuceneIndex.getOracleSearcherManager(int).

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.

startShardId - the ID of the starting shard.

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.

Returns:

a CloseableIterable object.