oracle.pg.text.solr

Class SolrVertexAutoIndex

java.lang.Object

oracle.pg.text.solr.SolrIndex<T>

oracle.pg.text.solr.SolrAutoIndex<com.tinkerpop.blueprints.Vertex>

oracle.pg.text.solr.SolrVertexAutoIndex

All Implemented Interfaces:

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

Direct Known Subclasses:

RDBMSSolrVertexAutoIndex

public abstract class SolrVertexAutoIndex
extends SolrAutoIndex<com.tinkerpop.blueprints.Vertex>
implements OracleAutoIndex<com.tinkerpop.blueprints.Vertex>

This class extends the functions defined in SolrAutoIndex. It manages automatic indexes defined on Vertex objects using SolrCloud.

Field Summary

Fields inherited from class oracle.pg.text.solr.SolrIndex

EDGE_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, VERSION_PROP, VERTEX_ID_PROP

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

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

Methods inherited from class oracle.pg.text.solr.SolrIndex

add, add, appendDatatypesSuffixToKey, appendDatatypesSuffixToValue, buildSearchTerm, buildSearchTerm, clearIndex, commit, commit, count, count, count, dropIndex, get, get, getCloudSolrServer, getDirectoryName, getGraphName, getIndexClass, getIndexName, getIndexParameters, getOracleIndexParameters, getParameters, getPartitioned, getShardsNames, getTotalShards, getTotalShards, put, query, query, remove, remove, remove, remove, 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(java.lang.Object solrQuery)

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, a SolrQuery object or a QueryResponse from SolrCloud.

Specified by:

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

Specified by:

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

Parameters:

solrQuery - a object representing the text query to execute.

Returns:

a CloseableIterable object.

get

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex> get(java.lang.String key,
                                                                                       java.lang.Object value,
                                                                                       java.lang.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 SolrIndex<com.tinkerpop.blueprints.Vertex>

Parameters:

key - the key of the indexed vertices.

value - the value of the indexed vertices.

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.

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

Returns:

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

getDocIdentifier

public java.lang.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 SolrIndex<com.tinkerpop.blueprints.Vertex>

Returns:

the document's identifier associated to this index.

getPartitioned

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

Gets an array of CloseableIterable objects that hold all the elements with an attribute matching the given K/V pair. Each element in the CloseableIterable array uses a separate connection provided to fetch a subset of the results from a corresponding SolrCloud shard. Note that we assign an integer ID (in the range of [0, N - 1]) to all the shards in a SolrCloud cluster with N shards. The subset of shards 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 SolrIndex<com.tinkerpop.blueprints.Vertex>

Parameters:

connections - an array of connections to the SolrCloud. Each element of this array should be of type CloudSolrServer. See SolrIndex.getCloudSolrServer(long).

solrQuery - a SolrQuery object.

startShardId - the ID of the starting shard.

Returns:

a CloseableIterable object.

getPartitioned

public com.tinkerpop.blueprints.CloseableIterable<com.tinkerpop.blueprints.Vertex>[] getPartitioned(java.lang.Object[] connections,
                                                                                                    java.lang.String key,
                                                                                                    java.lang.Object value,
                                                                                                    java.lang.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 element in the CloseableIterable array uses a separate connection provided to fetch a subset of the results from a corresponding SolrCloud shard. Note that we assign an integer ID (in the range of [0, N - 1]) to all the shards in a SolrCloud cluster with N shards. The subset of shards 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 SolrIndex<com.tinkerpop.blueprints.Vertex>

Parameters:

connections - an array of connections to the SolrCloud. Each element of this array should be of type CloudSolrServer. See SolrIndex.getCloudSolrServer(long).

key - the key of a property

value - the value object of the 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.

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

startShardId - the ID of the starting shard.

Returns:

a CloseableIterable object.