oracle.pg.text.solr

Class SolrEdgeIndex

java.lang.Object

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

oracle.pg.text.solr.SolrEdgeIndex

All Implemented Interfaces:

Index<Edge>, OracleIndex<Edge>

public class SolrEdgeIndex
extends SolrIndex<Edge>

This class extends the functions defined in SolrIndex. It manages manual indexes defined on Edge objects using SolrCloud.

Field Summary

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

EDGE_ID_PROP, TYPE_DT_BOOL, TYPE_DT_DATE, TYPE_DT_DOUBLE, TYPE_DT_FLOAT, TYPE_DT_INTEGER, TYPE_DT_SERIALIZABLE, TYPE_DT_STRING, VERSION_PROP, VERTEX_ID_PROP

Fields inherited from interface oracle.pg.text.OracleIndex

EDGE_LABEL_PROP, END_NODE_ID_PROP, START_NODE_ID_PROP

Constructor Summary

Constructors

Constructor and Description
SolrEdgeIndex(String indexName, OraclePropertyGraphBase oraclePropertyGraph, Parameter<String,Object>[] indexParameters, boolean erase) Constructs a new SolrEdgeIndex object.

Method Summary

Methods

Modifier and Type	Method and Description
CloseableIterable<Edge>	get(String key, Object value, Class dtClass, boolean acceptWildcard) Gets all edges indexed by the provided key/value.
String	getDocIdentifier() Gets the document's identifier associated to this index.
CloseableIterable<Edge>[]	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.solr.SolrIndex

add, add, buildSearchTerm, buildSearchTerm, clearIndex, close, commit, count, count, count, dropIndex, get, get, getCloudSolrServer, getDirectoryName, getGraphName, getIndexClass, getIndexName, getIndexParameters, getOracleIndexParameters, getParameters, getPartitioned, getShardsNames, getTotalShards, getTotalShards, isDelBatchEmpty, isDelBatchFull, isUpdatesBatchEmpty, isUpdatesBatchFull, put, 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.OracleIndex

refreshIndex

Constructor Detail

SolrEdgeIndex

public SolrEdgeIndex(String indexName,
             OraclePropertyGraphBase oraclePropertyGraph,
             Parameter<String,Object>[] indexParameters,
             boolean erase)

Constructs a new SolrEdgeIndex object.

Parameters:

indexName - the name of the index

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

get

public CloseableIterable<Edge> get(String key,
                          Object value,
                          Class dtClass,
                          boolean acceptWildcard)

Gets all edges indexed by the provided key/value.

Specified by:

get in interface OracleIndex<Edge>

Specified by:

get in class SolrIndex<Edge>

Parameters:

key - the key of the indexed edges.

value - the value of the indexed edges.

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 edges 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<Edge>

Overrides:

getDocIdentifier in class SolrIndex<Edge>

Returns:

the document's identifier associated to this index.

getPartitioned

public CloseableIterable<Edge>[] 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 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<Edge>

Specified by:

getPartitioned in class SolrIndex<Edge>

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.