oracle.pg.text.solr

Class SolrIndex<T extends Element>

java.lang.Object

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

All Implemented Interfaces:

Index<T>, OracleIndex<T>

Direct Known Subclasses:

SolrAutoIndex, SolrEdgeIndex, SolrVertexIndex

public abstract class SolrIndex<T extends Element>
extends Object
implements OracleIndex<T>

An abstract class implementing the Blueprints Index interface to support indices on SolrCloud.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDGE_ID_PROP A constant text index field name for the ID of an edge
static String	TYPE_DT_BOOL This constant denotes a Boolean data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_BYTE This constant denotes a Byte data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_CHAR This constant denotes a Character data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_DATE This constant denotes a Date (java.util.Date) data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_DOUBLE This constant denotes a Double data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_FLOAT This constant denotes a Float data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_INTEGER This constant denotes an Integer data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_JSON This constant denotes a JSON data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_LONG This constant denotes a Long data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_SERIALIZABLE This constant denotes a Serializable data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_SHORT This constant denotes a Short data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_SPATIAL This constant denotes a Spatial data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_STRING This constant denotes a String data type for the value field of an attribute (K/V pair)
static String	TYPE_DT_URI This constant denotes an URI data type for the value field of an attribute (K/V pair)
static String	VERSION_PROP This constant denotes an identifier for the version field of a document within the text index
static String	VERTEX_ID_PROP A constant text index field name for the ID of a vertex

Fields inherited from interface oracle.pg.text.OracleIndex

EDGE_LABEL_PROP, END_NODE_ID_PROP, m_dtValues, START_NODE_ID_PROP

Method Summary

Methods

Modifier and Type	Method and Description
void	add(T element) Adds a new element into the index using all its key/value pairs.
void	add(T element, org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer) Adds a new element into the index using all its key/value pairs.
String	appendDatatypesSuffixToKey(String key, Class dtValue) This operation will append the data type suffix to the key based on the LuceneIndex configuration.
String	appendDatatypesSuffixToValue(Object value, Class dtValue) This operation will append the data type suffix to the String representation of the given value based on the LuceneIndex configuration.
String	buildSearchTerm(String key, Object value) Builds a search term query expression in the syntax required by this index.
String	buildSearchTerm(String key, Object value, Class dtClass) Builds a search term query expression in the syntax required by this index.
void	clearIndex() Clears all data stored in the index.
void	close() Closes this SolrIndex object
void	commit() Commit changes
void	commit(org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer) Commit changes using the given CloudSolrServer object
long	count(String key, Object value) Counts all the elements matching the specified K/V property within the index
long	count(String key, Object value, boolean acceptWildcard) Counts all the elements matching the specified K/V property within the index
long	count(String key, Object value, Class dtClass, boolean acceptWildcard) Counts all the elements matching the specified K/V property within the index
void	dropIndex() Drops the index data
abstract CloseableIterable<T>	get(Object solrQuery) Gets an Iterable object with all the matching elements that match the given query object.
CloseableIterable<T>	get(String key, Object value) Gets all the elements matching the specified K/V property within the index
CloseableIterable<T>	get(String key, Object value, boolean acceptWildcard) Gets all the elements matching the specified K/V property within the index
abstract CloseableIterable<T>	get(String key, Object value, Class dtClass, boolean acceptWildcard) Gets all the elements matching the specified K/V property within the index
org.apache.solr.client.solrj.impl.CloudSolrServer	getCloudSolrServer(long timeout) Gets a new CloudSolrServer object to handle operations over the index.
String	getDirectoryName() Gets the directory name for this index.
String	getDocIdentifier() Get index document's identifier.
String	getGraphName() Get the name of the associated graph
Class<T>	getIndexClass() Gets the element class associated to this index.
String	getIndexName() Gets the name of this index instance.
SolrParameters	getIndexParameters() Gets the index parameters utility associated to this index.
OracleIndexParameters	getOracleIndexParameters() Gets an OracleIndexParameters wrapping the parameters associated to this index
Parameter<String,Object>[]	getParameters() Gets the Parameters associated to this index.
abstract CloseableIterable<T>[]	getPartitioned(Object[] connections, Object query, int startShardId) Gets an array of CloseableIterable objects that hold all the elements with an attribute matching the given K/V pair.
CloseableIterable<T>[]	getPartitioned(Object[] connections, String key, Object value, boolean acceptWildcard, int startShardId) Gets an array of CloseableIterable objects that hold all the elements with an attribute matching the given K/V pair.
abstract CloseableIterable<T>[]	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.
List<String>	getShardsNames() Gets the list of shards' names used for this SolrCloud index
int	getTotalShards() Gets the number of shards (directories) in this index
int	getTotalShards(org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer) Gets the number of shards (directories) in this index
void	put(String key, Object value, T element) Indexes an element by a key and a value.
void	put(String key, Object value, T element, org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer) Indexes an element by a key and a value.
CloseableIterable<T>	query(String key, Object value) Query for all the elements matching the specified K/V property within the index
CloseableIterable<T>	query(String key, Object value, boolean useWildcards) Query for all the elements matching the specified K/V property within the index
void	remove(String key, Object value, Class dtClass, T element, org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer) Removes an element indexed by a particular key/value.
void	remove(String key, Object value, T element) Removes an element indexed by a particular key/value.
void	remove(String key, Object value, T element, org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer) Removes an element indexed by a particular key/value.
void	remove(T element) Deletes an element from this index
void	removeAll(String key) Removes all the elements from the index matching the specified key.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EDGE_ID_PROP

public static final String EDGE_ID_PROP

A constant text index field name for the ID of an edge

See Also:

Constant Field Values

TYPE_DT_BOOL

public static final String TYPE_DT_BOOL

This constant denotes a Boolean data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_BYTE

public static final String TYPE_DT_BYTE

This constant denotes a Byte data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_CHAR

public static final String TYPE_DT_CHAR

This constant denotes a Character data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_DATE

public static final String TYPE_DT_DATE

This constant denotes a Date (java.util.Date) data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_DOUBLE

public static final String TYPE_DT_DOUBLE

This constant denotes a Double data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_FLOAT

public static final String TYPE_DT_FLOAT

This constant denotes a Float data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_INTEGER

public static final String TYPE_DT_INTEGER

This constant denotes an Integer data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_JSON

public static final String TYPE_DT_JSON

This constant denotes a JSON data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_LONG

public static final String TYPE_DT_LONG

This constant denotes a Long data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_SERIALIZABLE

public static final String TYPE_DT_SERIALIZABLE

This constant denotes a Serializable data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_SHORT

public static final String TYPE_DT_SHORT

This constant denotes a Short data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_SPATIAL

public static final String TYPE_DT_SPATIAL

This constant denotes a Spatial data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_STRING

public static final String TYPE_DT_STRING

This constant denotes a String data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

TYPE_DT_URI

public static final String TYPE_DT_URI

This constant denotes an URI data type for the value field of an attribute (K/V pair)

See Also:

Constant Field Values

VERSION_PROP

public static final String VERSION_PROP

This constant denotes an identifier for the version field of a document within the text index

See Also:

Constant Field Values

VERTEX_ID_PROP

public static final String VERTEX_ID_PROP

A constant text index field name for the ID of a vertex

See Also:

Constant Field Values

Method Detail

add

public void add(T element)

Adds a new element into the index using all its key/value pairs.

Specified by:

add in interface OracleIndex<T extends Element>

Parameters:

element - a Element object.

Throws:

IOException

add

public void add(T element,
       org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer)

Adds a new element into the index using all its key/value pairs.

Parameters:

element - a Element object.

cloudSolrServer - if not null, use the opened CloudSolrServer connection, this avoids opening/closing a CloudSolrServer connection at flush time.

Throws:

IOException

appendDatatypesSuffixToKey

public String appendDatatypesSuffixToKey(String key,
                                Class dtValue)

This operation will append the data type suffix to the key based on the LuceneIndex configuration. The data type suffix is required in order to retrieve matches when executing a text search query over a Key/Value pair.

Parameters:

key - the key of the K/V property

dtValue - the data type of the value object

Returns:

a Lucene syntax String representation of the key with respect to the given datatype

appendDatatypesSuffixToValue

public String appendDatatypesSuffixToValue(Object value,
                                  Class dtValue)

This operation will append the data type suffix to the String representation of the given value based on the LuceneIndex configuration. The data type suffix is required in order to retrieve matches when executing a text search query over a Key/Value pair.

Parameters:

value - the value of the K/V property

dtValue - the data type of the value object

Returns:

a Lucene syntax String representation of the value with respect to the given datatype

buildSearchTerm

public String buildSearchTerm(String key,
                     Object value)

Builds a search term query expression in the syntax required by this index.

Specified by:

buildSearchTerm in interface OracleIndex<T extends Element>

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

buildSearchTerm

public String buildSearchTerm(String key,
                     Object value,
                     Class dtClass)

Builds a search term query expression in the syntax required by this index.

Specified by:

buildSearchTerm in interface OracleIndex<T extends Element>

Parameters:

key - the key of the K/V property

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

clearIndex

public void clearIndex()

Clears all data stored in the index.

Specified by:

clearIndex in interface OracleIndex<T extends Element>

close

public void close()

Closes this SolrIndex object

Specified by:

close in interface OracleIndex<T extends Element>

commit

public void commit()

Commit changes

Specified by:

commit in interface OracleIndex<T extends Element>

commit

public void commit(org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer)

Commit changes using the given CloudSolrServer object

count

public final long count(String key,
         Object value)

Counts all the elements matching the specified K/V property within the index

Specified by:

count in interface Index<T extends Element>

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

Returns:

a the number of elements matching the specified K/V property within the index

count

public final long count(String key,
         Object value,
         boolean acceptWildcard)

Counts all the elements matching the specified K/V property within the index

Specified by:

count in interface OracleIndex<T extends Element>

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

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

Returns:

a CloseableIterable object.

count

public long count(String key,
         Object value,
         Class dtClass,
         boolean acceptWildcard)

Counts all the elements matching the specified K/V property within the index

Specified by:

count in interface OracleIndex<T extends Element>

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

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:

a positive long integer representing the number of elements matching the K/V property.

dropIndex

public final void dropIndex()

Drops the index data

Specified by:

dropIndex in interface OracleIndex<T extends Element>

get

public abstract CloseableIterable<T> get(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<T extends Element>

Parameters:

solrQuery - a object representing the text query to execute.

Returns:

a CloseableIterable object.

get

public final CloseableIterable<T> get(String key,
                       Object value)

Gets all the elements matching the specified K/V property within the index

Specified by:

get in interface Index<T extends Element>

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

Returns:

a CloseableIterable object.

get

public final CloseableIterable<T> get(String key,
                       Object value,
                       boolean acceptWildcard)

Gets all the elements matching the specified K/V property within the index

Specified by:

get in interface OracleIndex<T extends Element>

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

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

Returns:

a CloseableIterable object.

get

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

Gets all the elements matching the specified K/V property within the index

Specified by:

get in interface OracleIndex<T extends Element>

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

dtClass - the class representing the datatype of the searched values.

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

Returns:

a CloseableIterable object.

getCloudSolrServer

public org.apache.solr.client.solrj.impl.CloudSolrServer getCloudSolrServer(long timeout)

Gets a new CloudSolrServer object to handle operations over the index.

Returns:

a new instance of CloudSolrServer

getDirectoryName

public final String getDirectoryName()

Gets the directory name for this index.

Specified by:

getDirectoryName in interface OracleIndex<T extends Element>

Returns:

the directory name for this index.

getDocIdentifier

public String getDocIdentifier()

Get index document's identifier.

Specified by:

getDocIdentifier in interface OracleIndex<T extends Element>

Returns:

a String representing the document's identifier based on the entity type it handles (edge or vertex).

getGraphName

public final String getGraphName()

Get the name of the associated graph

Specified by:

getGraphName in interface OracleIndex<T extends Element>

getIndexClass

public final Class<T> getIndexClass()

Gets the element class associated to this index.

Specified by:

getIndexClass in interface Index<T extends Element>

Specified by:

getIndexClass in interface OracleIndex<T extends Element>

Returns:

Vertex.class if this is a vertex index or Edge.class if this is an Edge index.

getIndexName

public final String getIndexName()

Gets the name of this index instance.

Specified by:

getIndexName in interface Index<T extends Element>

Returns:

the name of this index.

getIndexParameters

public SolrParameters getIndexParameters()

Gets the index parameters utility associated to this index.

Returns:

an SolrParameters object.

getOracleIndexParameters

public OracleIndexParameters getOracleIndexParameters()

Gets an OracleIndexParameters wrapping the parameters associated to this index

Specified by:

getOracleIndexParameters in interface OracleIndex<T extends Element>

Returns:

a OracleIndexParameters object.

getParameters

public Parameter<String,Object>[] getParameters()

Gets the Parameters associated to this index.

Specified by:

getParameters in interface OracleIndex<T extends Element>

Returns:

a Parameter array.

getPartitioned

public abstract CloseableIterable<T>[] getPartitioned(Object[] connections,
                                    Object query,
                                    int startShardId)

Gets an array of CloseableIterable objects that hold all the elements with an attribute matching the given K/V pair. This object can be either a String text search query, a SolrQuery object or a QueryResponse from SolrCloud. 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<T extends Element>

Parameters:

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

startShardId - the ID of the starting shard.

query - the query object.

Returns:

a CloseableIterable object.

getPartitioned

public final CloseableIterable<T>[] getPartitioned(Object[] connections,
                                    String key,
                                    Object value,
                                    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<T extends Element>

Parameters:

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

key - the key of a property

value - the value object of the property.

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

startShardId - the ID of the starting shard.

Returns:

a CloseableIterable object.

getPartitioned

public abstract CloseableIterable<T>[] 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<T extends Element>

Parameters:

connections - an array of connections to the SolrCloud. Each element of this array should be of type CloudSolrServer. See 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.

getShardsNames

public List<String> getShardsNames()

Gets the list of shards' names used for this SolrCloud index

getTotalShards

public int getTotalShards()

Gets the number of shards (directories) in this index

Specified by:

getTotalShards in interface OracleIndex<T extends Element>

getTotalShards

public int getTotalShards(org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer)

Gets the number of shards (directories) in this index

Parameters:

cloudSolrServer - if not null, use the opened CloudSolrServer connection, this avoids opening/closing a CloudSolrServer connection at flush time.

put

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

Indexes an element by a key and a value.

Specified by:

put in interface Index<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 void put(String key,
       Object value,
       T element,
       org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer)

Indexes an element by a key and a value. Using a cloudSolrServer object helps open/commit/close connections to SolrCloud. The user is responsible of executing commits the cloudSolrServer object so the changes executed by this operation are persisted into the text index.

Parameters:

key - the key to index the element by.

value - the value to index the element by.

element - the element to index.

cloudSolrServer - if not null, use the opened CloudSolrServer connection, this avoids opening/closing a CloudSolrServer connection at flush time.

query

public final CloseableIterable<T> query(String key,
                         Object value)

Query for all the elements matching the specified K/V property within the index

Specified by:

query in interface Index<T extends Element>

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

Returns:

a CloseableIterable object.

query

public final CloseableIterable<T> query(String key,
                         Object value,
                         boolean useWildcards)

Query for all the elements matching the specified K/V property within the index

Specified by:

query in interface OracleIndex<T extends Element>

Parameters:

key - the key of the K/V property

value - the value object of the K/V property

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

Returns:

a CloseableIterable object.

remove

public void remove(String key,
          Object value,
          Class dtClass,
          T element,
          org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer)

Removes an element indexed by a particular key/value. Using a cloudSolrServer object helps open/commit/close connections to SolrCloud. The user is responsible of executing commits the cloudSolrServer object so the changes executed by this operation are persisted into the text index.

Parameters:

key - the key of the indexed element.

value - the value of the indexed element.

dtClass - the data type class of the indexed element.

element - the element to remove given the key/value pair.

cloudSolrServer - if not null, use the opened CloudSolrServer connection, this avoids opening/closing a CloudSolrServer connection at flush time.

remove

public void remove(String key,
          Object value,
          T element)

Removes an element indexed by a particular key/value.

Specified by:

remove in interface Index<T extends Element>

Parameters:

key - the key of the indexed element.

value - the value of the indexed element.

element - the element to remove given the key/value pair.

remove

public void remove(String key,
          Object value,
          T element,
          org.apache.solr.client.solrj.impl.CloudSolrServer cloudSolrServer)

Removes an element indexed by a particular key/value. Using a cloudSolrServer object helps open/commit/close connections to SolrCloud. The user is responsible of executing commits the cloudSolrServer object so the changes executed by this operation are persisted into the text index.

Parameters:

key - the key of the indexed element.

value - the value of the indexed element.

element - the element to remove given the key/value pair.

cloudSolrServer - if not null, use the opened CloudSolrServer connection, this avoids opening/closing a CloudSolrServer connection at flush time.

remove

public void remove(T element)

Deletes an element from this index

Specified by:

remove in interface OracleIndex<T extends Element>

Parameters:

element - an Element object.

Throws:

IOException

removeAll

public void removeAll(String key)

Removes all the elements from the index matching the specified key.

Specified by:

removeAll in interface OracleIndex<T extends Element>

Parameters:

key - the key to remove from the index.