public interface OracleIndex<T extends com.tinkerpop.blueprints.Element>
extends com.tinkerpop.blueprints.Index<T>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EDGE_ID_PROP
A constant text index field name for the ID of an edge
|
static java.lang.String |
EDGE_LABEL_PROP
A constant text index field name for the label of an edge
|
static java.lang.String |
END_NODE_ID_PROP
A constant text index field name for the ID of an edge's head (destination) vertex
|
static java.lang.Class[] |
m_dtValues
This constant denotes the array of supported data types @deprecated
|
static java.lang.String |
START_NODE_ID_PROP
A constant text index field name for the ID of an edge's tail (starting) vertex
|
static char |
TYPE_DT_BOOL
This constant denotes a Boolean data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_BYTE
This constant denotes a Byte data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_CHAR
This constant denotes a Character data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_DATE
This constant denotes a Date (java.util.Date) data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_DOUBLE
This constant denotes a Double data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_FLOAT
This constant denotes a Float data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_INTEGER
This constant denotes an Integer data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_JSON
This constant denotes a JSON data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_LONG
This constant denotes a Long data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_SERIALIZABLE
This constant denotes a Serializable data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_SHORT
This constant denotes a Short data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_SPATIAL
This constant denotes a Spatial data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_STRING
This constant denotes a String data type for the value field of an attribute (K/V pair)
|
static char |
TYPE_DT_URI
This constant denotes a URI data type for the value field of an attribute (K/V pair)
|
static java.lang.String |
VERTEX_ID_PROP
A constant text index field name for the ID of a vertex
|
Modifier and Type | Method and Description |
---|---|
void |
add(T element)
Adds a new Element into the index using all its associated key/value pairs
|
java.lang.String |
buildSearchTerm(java.lang.String key, java.lang.Object value)
Builds a search term query expression in the syntax required by this index.
|
java.lang.String |
buildSearchTerm(java.lang.String key, java.lang.Object value, java.lang.Class dtClass)
Builds a search term query expression in the syntax required by this index.
|
void |
clearIndex()
Clears all data stored in the text index.
|
void |
close()
Closes this index object.
|
void |
commit()
Commit changes
|
long |
count(java.lang.String key, java.lang.Object value, boolean acceptWildcard)
Counts all the matching elements that have a particular key/value property within the index
|
long |
count(java.lang.String key, java.lang.Object value, java.lang.Class dtClass, boolean acceptWildcard)
Counts all the matching elements that have a particular key/value property within the index
|
void |
dropIndex()
Drops and removes all data from the text index (including its directory)
|
com.tinkerpop.blueprints.CloseableIterable<T> |
get(java.lang.Object query)
Gets an Iterable object with all the matching elements that have a particular key/value property within the index
|
com.tinkerpop.blueprints.CloseableIterable<T> |
get(java.lang.String key, java.lang.Object value, boolean acceptWildcard)
Gets an Iterable object with all the matching elements that have a particular key/value property within the index
|
com.tinkerpop.blueprints.CloseableIterable<T> |
get(java.lang.String key, java.lang.Object value, java.lang.Class dtValue, boolean acceptWildcard)
Gets an Iterable object with all the matching elements that have a particular key/value property within the index
|
java.lang.String |
getDirectoryName()
Gets the directory name for this index.
|
java.lang.String |
getDocIdentifier()
Get index document's identifier.
|
java.lang.String |
getGraphName()
Get the name of the associated graph
|
java.lang.Class<T> |
getIndexClass()
Gets the class associated to this index
|
OracleIndexParameters |
getOracleIndexParameters()
Gets the OracleIndexParameters associated to this index
|
com.tinkerpop.blueprints.Parameter[] |
getParameters()
Gets the OracleIndexParameters associated to this index
|
com.tinkerpop.blueprints.CloseableIterable<T>[] |
getPartitioned(java.lang.Object[] connections, java.lang.Object query, 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<T>[] |
getPartitioned(java.lang.Object[] connections, java.lang.String key, java.lang.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. |
com.tinkerpop.blueprints.CloseableIterable<T>[] |
getPartitioned(java.lang.Object[] connections, java.lang.String key, java.lang.Object value, java.lang.Class dtValue, boolean acceptWildcard, int startShardId)
Gets an array of
CloseableIterable objects that hold all the elements with an attribute matching the given K/V pair. |
int |
getTotalShards()
Gets the number of shards (directories) in this index
|
com.tinkerpop.blueprints.CloseableIterable<T> |
query(java.lang.String key, java.lang.Object value, boolean useWildcards)
Query for all the elements satisfying the specified K/V property within the index
|
void |
remove(T element)
Deletes an element from this index
|
void |
removeAll(java.lang.String key)
Removes all the elements from the index matching the specified key.
|
static final java.lang.String EDGE_ID_PROP
static final java.lang.String EDGE_LABEL_PROP
static final java.lang.String END_NODE_ID_PROP
static final java.lang.Class[] m_dtValues
static final java.lang.String START_NODE_ID_PROP
static final char TYPE_DT_BOOL
static final char TYPE_DT_BYTE
static final char TYPE_DT_CHAR
static final char TYPE_DT_DATE
static final char TYPE_DT_DOUBLE
static final char TYPE_DT_FLOAT
static final char TYPE_DT_INTEGER
static final char TYPE_DT_JSON
static final char TYPE_DT_LONG
static final char TYPE_DT_SERIALIZABLE
static final char TYPE_DT_SHORT
static final char TYPE_DT_SPATIAL
static final char TYPE_DT_STRING
static final char TYPE_DT_URI
static final java.lang.String VERTEX_ID_PROP
void add(T element)
element
- an Element
object.java.io.IOException
java.lang.String buildSearchTerm(java.lang.String key, java.lang.Object value)
key
- the key of the K/V propertyvalue
- the value object of the K/V propertyjava.lang.String buildSearchTerm(java.lang.String key, java.lang.Object value, java.lang.Class dtClass)
key
- the key of the K/V propertyvalue
- the value object of the K/V propertydtClass
- 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.void clearIndex()
void close()
void commit()
long count(java.lang.String key, java.lang.Object value, boolean acceptWildcard)
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.long count(java.lang.String key, java.lang.Object value, java.lang.Class dtClass, boolean acceptWildcard)
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.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.CloseableIterable
object.void dropIndex()
com.tinkerpop.blueprints.CloseableIterable<T> get(java.lang.Object query)
query
- the query object.CloseableIterable
object.com.tinkerpop.blueprints.CloseableIterable<T> get(java.lang.String key, java.lang.Object value, boolean acceptWildcard)
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.CloseableIterable
object.com.tinkerpop.blueprints.CloseableIterable<T> get(java.lang.String key, java.lang.Object value, java.lang.Class dtValue, boolean acceptWildcard)
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.dtValue
- 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.acceptWildcard
- specifies if wild cards can be used in the value object.CloseableIterable
object.java.lang.String getDirectoryName()
java.lang.String getDocIdentifier()
java.lang.String getGraphName()
java.lang.Class<T> getIndexClass()
getIndexClass
in interface com.tinkerpop.blueprints.Index<T extends com.tinkerpop.blueprints.Element>
OracleIndexParameters getOracleIndexParameters()
com.tinkerpop.blueprints.Parameter[] getParameters()
com.tinkerpop.blueprints.CloseableIterable<T>[] getPartitioned(java.lang.Object[] connections, java.lang.Object query, int startShardId)
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 shard. Note that we assign an integer ID (in the range of [0, N - 1]) to all the shards in the index 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].connections
- an array of connections to the search engine.query
- the query object.startShardId
- the ID of the starting shard.CloseableIterable
object.com.tinkerpop.blueprints.CloseableIterable<T>[] getPartitioned(java.lang.Object[] connections, java.lang.String key, java.lang.Object value, boolean acceptWildcard, int startShardId)
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 shard. Note that we assign an integer ID (in the range of [0, N - 1]) to all the shards in the index 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].connections
- an array of connections to the search engine.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.CloseableIterable
object.com.tinkerpop.blueprints.CloseableIterable<T>[] getPartitioned(java.lang.Object[] connections, java.lang.String key, java.lang.Object value, java.lang.Class dtValue, boolean acceptWildcard, int startShardId)
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 shard. Note that we assign an integer ID (in the range of [0, N - 1]) to all the shards in the index 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].connections
- an array of connections to the search engine.key
- the key of a propertyvalue
- the value object of the property.dtValue
- 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.CloseableIterable
object.int getTotalShards()
com.tinkerpop.blueprints.CloseableIterable<T> query(java.lang.String key, java.lang.Object value, boolean useWildcards)
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.useWildcards
- specifies if wild cards can be used in the value object.CloseableIterable
object.void remove(T element)
element
- an Element
object.java.io.IOException
void removeAll(java.lang.String key)
key
- the key to remove from the index.Copyright © 2017, 2018 Oracle and/or its affiliates. All Rights Reserved.