oracle.pg.common

Interface OracleIndexableGraph

All Superinterfaces:

oracle.pg.common.messages.MesgConsts, OracleMessageConstants

All Known Implementing Classes:

OraclePropertyGraph, OraclePropertyGraphBase, SQLAnalyticsGraph

public interface OracleIndexableGraph
extends oracle.pg.common.messages.MesgConsts, OracleMessageConstants

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ms_bDebug
static SimpleLog	ms_log

Fields inherited from interface oracle.pg.common.OracleMessageConstants

MG_ERR_USER_REQ_OP_CANCEL, ms_nfe, MSG_E_AUTO_IDX_MUST_SOLR_OR_LUCENE, MSG_E_AUTO_IDX_NOT_EXIST, MSG_ERR_ARG_CANNOT_BE_NULL, MSG_ERR_ID_CANNOT_BE_NULL, MSG_ERR_NO_ELEM_TO_BE_CONSUMED, MSG_ERR_NO_OP_SUPPORTED, MSG_IDX_KEY_NOT_NULL, MSG_IDX_KEYS_NOT_NULL, MSG_TXT_IDX_NOT_FOUND, MSG_V_AUTO_IDX_MUST_SOLR_OR_LUCENE, MSG_V_AUTO_IDX_NOT_EXIST

Fields inherited from interface oracle.pg.common.messages.MesgConsts

ERR_ARG_CANNOT_BE_NULL, ERR_CODE_NOT_IN_LIST, ERR_DOP_CONSTRAINT, ERR_E_AUTO_IDX_MUST_SOLR_OR_LUCENE, ERR_E_AUTO_IDX_NOT_EXIST, ERR_E_DS_MUSTBE_FILE_OR_IS, ERR_E_MAX_LINE_CONSTRAINT, ERR_EDGE_DIR_NOT_BOTH, ERR_EDGE_WORK_TBL_NOT_CLEAN, ERR_GRAPH_NAME_CANT_BENULL, ERR_HIT_EXCEPTION, ERR_HIT_INTERRUPT, ERR_HIT_IO, ERR_HIT_OPGE, ERR_HIT_PARSEE, ERR_ID_CANNOT_BE_NULL, ERR_IDX_KEY_CANNOT_BE_NULL, ERR_IDX_KEY_NOT_NULL, ERR_IDX_KEYS_NOT_NULL, ERR_IN_DS_EDGE_CANTBE_NULL, ERR_IN_DS_VERT_CANTBE_NULL, ERR_IN_E_FLAT_DOESNT_EXIST, ERR_IN_V_FLAT_DOESNT_EXIST, ERR_INPUT_LIST_NOT_NULL, ERR_INPUT_NOT_NULL, ERR_INVALID_CHANGE_ACTION, ERR_INVALID_NUM_FIELDS, ERR_INVALID_NUM_NOARG, ERR_INVALID_NUMBER, ERR_INVALID_VAL, ERR_KEY_CANNOT_BE_ID, ERR_KEY_CANNOT_BE_NULL, ERR_KEY_CANNOT_BE_NULL_EMPTY, ERR_KEY_NOT_SET_TO, ERR_NO_ELEM_TO_BE_CONSUMED, ERR_NO_OP_SUPPORTED, ERR_NOT_IMPLEMENTED_YET, ERR_NOT_ORACLE_V_E, ERR_NUM_PART_CONSTRAINT, ERR_OFFSET_CONSTRAINT, ERR_OFFSET_E_MUST_BE_POS, ERR_OFFSET_V_MUST_BE_POS, ERR_OPT_FLAG_EDGE_INVALID, ERR_OPT_FLAG_VERT_INVALID, ERR_ORA_TEXT_INVALID_KEY, ERR_ORA_TEXT_ONLY_AUTO, ERR_OUTPUT_LIST_NOT_NULL, ERR_PG_ALREADY_EXISTS, ERR_PG_NOT_EMPTY, ERR_PG_NOT_NULL, ERR_SIZE_MUST_BE_POS, ERR_TIMEOUT_TAB_CREATION, ERR_TXT_IDX_NOT_FOUND, ERR_TYPE_ID_NOT_RECO, ERR_UNSUPPORTED_VAL_TYP, ERR_USER_REQ_OP_CANCEL, ERR_V_AUTO_IDX_MUST_SOLR_OR_LUCENE, ERR_V_AUTO_IDX_NOT_EXIST, ERR_V_DS_MUSTBE_FILE_OR_IS, ERR_V_MAX_LINE_CONSTRAINT, ERR_VALUE_CANNOT_BE_NULL, INFO_EMP_K_NO_P_VAL, INFO_NUL_K_NO_P_VAL

Method Summary

Modifier and Type	Method and Description
<T extends OracleElementBase> OracleIndex<T>	createIndex(java.lang.String indexName, java.lang.Class<T> indexClass, Parameter... indexParameters) Generates an index with a particular name, for a particular class, and of a particular type.
default <T extends OracleElementBase> void	createKeyIndex(java.lang.String[] keys, java.lang.Class<T> elementClass) Creates an automatically maintained index for the given keys and element class.
default <T extends OracleElementBase> void	createKeyIndex(java.lang.String[] keys, java.lang.Class<T> elementClass, Parameter... parameters) Creates an automatically maintained index for the given keys and element class.
default <T extends OracleElementBase> void	createKeyIndex(java.lang.String key, java.lang.Class<T> elementClass, Parameter... parameters) Creates an automatic indexing structure for indexing provided key for element class.
default void	dropAllAutoIndices() Drops all existing automatic indices (vertex and edges).
default void	dropAllIndices() Drops all existing indices.
default void	dropAllManualIndices() Drops all existing manual indices (vertices and edges).
default void	dropIndex(java.lang.String indexName) Removes an index associated with the graph.
default <T extends OracleElementBase> void	dropKeyIndex(java.lang.String[] keys, java.lang.Class<T> elementClass) Removes an automatic indexing structure associated with indexing provided key for element class.
default <T extends OracleElementBase> void	dropKeyIndex(java.lang.String[] keys, java.lang.Class<T> elementClass, Parameter... parameters) Removes an automatic indexing structure associated with indexing provided key for element class.
default <T extends OracleElementBase> void	dropKeyIndex(java.lang.String key, java.lang.Class<T> elementClass) Removes an automatic indexing structure associated with indexing provided key for element class.
default <T extends OracleElementBase> OracleIndex<T>	getAutoIndex(java.lang.Class<T> indexClass) Gets an automatic index from the graph by its name and index class.
default java.lang.Class<?>	getDatatypeClassFromValueObjForTextIndex(java.lang.Object value) Gets the data type class from the given value object.
OracleIndexParameters	getDefaultIndexParameters() Get the public default index parameters associated to this property graph.
default <T extends OracleElementBase> OracleIndex<T>	getIndex(java.lang.String indexName, java.lang.Class<T> indexClass) Gets a manual index from the graph by its name and index class.
default <T extends OracleElementBase> java.util.Set<java.lang.String>	getIndexedKeys(java.lang.Class<T> elementClass) Returns all the index keys associated with a particular element class.
default <T extends OracleElementBase> OracleIndexParameters	getIndexParameters(java.lang.String indexName, java.lang.Class<T> indexClass) Gets the index parameters associated to the given text index.
default java.util.Iterator<OracleIndex<? extends OracleElementBase>>	getIndices() Gets all the indices maintained by the graph.
OracleIndexManager	getOracleIndexManager() Gets the OracleIndexManager object associated to this property graph instance.
default boolean	isEdgeAutoIndexEnabled(java.lang.String key) Validates if the edge auto index is currently enabled
default boolean	isVertexAutoIndexEnabled(java.lang.String key) Validates if the vertex auto index is currently enabled
default void	refreshAutoIndices() Refreshes all automatic indices based to the most up-to-date state of the property graph.
void	setDefaultIndexParameters(OracleIndexParameters indexParams) Set the public default index parameters associated to this property graph.
default void	validateIndexManager()

Field Detail

ms_bDebug

static final boolean ms_bDebug

ms_log

static final SimpleLog ms_log

Method Detail

createIndex

<T extends OracleElementBase> OracleIndex<T> createIndex(java.lang.String indexName,
                                                         java.lang.Class<T> indexClass,
                                                         Parameter... indexParameters)

Generates an index with a particular name, for a particular class, and of a particular type.

Parameters:

indexName - the name of the index

indexClass - the element class that this index is indexing (can be base class)

indexParameters - a collection of parameters for the underlying index implementation

Returns:

the index created

createKeyIndex

default <T extends OracleElementBase> void createKeyIndex(java.lang.String[] keys,
                                                          java.lang.Class<T> elementClass)

Creates an automatically maintained index for the given keys and element class. If the automatic index already exists, the index configuration parameters will be taken from the index metadata table.

Parameters:

keys - an array of keys to create the index for.

elementClass - the element class that the index is for.

createKeyIndex

default <T extends OracleElementBase> void createKeyIndex(java.lang.String[] keys,
                                                          java.lang.Class<T> elementClass,
                                                          Parameter... parameters)

Creates an automatically maintained index for the given keys and element class. If the automatic index already exists, the index configuration parameters will be taken from the index metadata table.

Parameters:

keys - an array of keys to create the index for.

elementClass - the element class that the index is for.

parameters - the parameters used by the indexing structure. If the index is already defined, this parameters will not be considered. To take into consideration the parameters for the creation of an index, first drop the existing index and recreate.

createKeyIndex

default <T extends OracleElementBase> void createKeyIndex(java.lang.String key,
                                                          java.lang.Class<T> elementClass,
                                                          Parameter... parameters)

Creates an automatic indexing structure for indexing provided key for element class. If the automatic index already exists, the index configuration parameters will be taken from the index metadata table.

Parameters:

key - the key to create the index for.

elementClass - the element class that the index is for.

parameters - the parameters used by the indexing structure. If the index is already defined, this parameters will not be considered. To take into consideration the parameters for the creation of an index, first drop the existing index and recreate.

dropAllAutoIndices

default void dropAllAutoIndices()

Drops all existing automatic indices (vertex and edges). This operation will delete the indexing structure and remove all index configuration parameters stored in the index metada table IT.

dropAllIndices

default void dropAllIndices()

Drops all existing indices. This operation will delete the indexing structure and remove all index configuration parameters stored in the index metada table IT.

dropAllManualIndices

default void dropAllManualIndices()

Drops all existing manual indices (vertices and edges). This operation will delete the indexing structure and remove all index configuration parameters stored in the index metada table IT.

dropIndex

default void dropIndex(java.lang.String indexName)

Removes an index associated with the graph.

Parameters:

indexName - the name of the index to drop

dropKeyIndex

default <T extends OracleElementBase> void dropKeyIndex(java.lang.String[] keys,
                                                        java.lang.Class<T> elementClass)

Removes an automatic indexing structure associated with indexing provided key for element class. If there are no more indexed keys in the automatic index, all index configuration will be removed from the index metadata table and the index structure will be deleted.

Parameters:

keys - an array of keys to drop the index for.

elementClass - the element class that the index is for.

dropKeyIndex

default <T extends OracleElementBase> void dropKeyIndex(java.lang.String[] keys,
                                                        java.lang.Class<T> elementClass,
                                                        Parameter... parameters)

Removes an automatic indexing structure associated with indexing provided key for element class. If there are no more indexed keys in the automatic index, all index configuration will be removed from the index metadata table and the index structure will be deleted.

Parameters:

keys - an array of keys to drop the index for.

elementClass - the element class that the index is for.

parameters - the parameters used by the indexing structure. If the index is already defined, this parameters will not be considered. To take into consideration the parameters for the creation of an index, first drop the existing index and recreate.

dropKeyIndex

default <T extends OracleElementBase> void dropKeyIndex(java.lang.String key,
                                                        java.lang.Class<T> elementClass)

Removes an automatic indexing structure associated with indexing provided key for element class. If there are no more indexed keys in the automatic index, all index configuration will be removed from the index metadata table and the index structure will be deleted.

Parameters:

key - the key to drop the index for.

elementClass - the element class that the index is for.

getAutoIndex

default <T extends OracleElementBase> OracleIndex<T> getAutoIndex(java.lang.Class<T> indexClass)

Gets an automatic index from the graph by its name and index class. An index is unique up to name.

Parameters:

indexClass - the element class that the index is for.

getDatatypeClassFromValueObjForTextIndex

default java.lang.Class<?> getDatatypeClassFromValueObjForTextIndex(java.lang.Object value)

Gets the data type class from the given value object. This is the data type that will be used for text indexing.

getDefaultIndexParameters

OracleIndexParameters getDefaultIndexParameters()

Get the public default index parameters associated to this property graph. The index parameters provided here will be used when an automatic or manual index is to be created without an explicit specification of the index parameters.

Returns:

a OracleIndexParameters object.

getIndex

default <T extends OracleElementBase> OracleIndex<T> getIndex(java.lang.String indexName,
                                                              java.lang.Class<T> indexClass)

Gets a manual index from the graph by its name and index class. An index is unique up to name.

Parameters:

indexName - the name of the manual index to retrieve.

indexClass - the element class that the index is for.

getIndexedKeys

default <T extends OracleElementBase> java.util.Set<java.lang.String> getIndexedKeys(java.lang.Class<T> elementClass)

Returns all the index keys associated with a particular element class.

Parameters:

elementClass - the element class that the index is for.

Returns:

the indexed keys as a Set.

getIndexParameters

default <T extends OracleElementBase> OracleIndexParameters getIndexParameters(java.lang.String indexName,
                                                                               java.lang.Class<T> indexClass)

Gets the index parameters associated to the given text index.

Parameters:

indexName - the name of the manual index to retrieve.

indexClass - the element class that the index is for.

Returns:

a OracleIndexParameters object.

getIndices

default java.util.Iterator<OracleIndex<? extends OracleElementBase>> getIndices()

Gets all the indices maintained by the graph.

Returns:

the indices associated with the graph

getOracleIndexManager

OracleIndexManager getOracleIndexManager()

Gets the OracleIndexManager object associated to this property graph instance.

Returns:

a OracleIndexManager object.

isEdgeAutoIndexEnabled

default boolean isEdgeAutoIndexEnabled(java.lang.String key)

Validates if the edge auto index is currently enabled

isVertexAutoIndexEnabled

default boolean isVertexAutoIndexEnabled(java.lang.String key)

Validates if the vertex auto index is currently enabled

refreshAutoIndices

default void refreshAutoIndices()

Refreshes all automatic indices based to the most up-to-date state of the property graph.

setDefaultIndexParameters

void setDefaultIndexParameters(OracleIndexParameters indexParams)

Set the public default index parameters associated to this property graph. The indexParams provided here will be used when an automatic or manual index is to be created without an explicit specification of the index parameters.

Parameters:

indexParams - a OracleIndexParameters object.

validateIndexManager

default void validateIndexManager()