com.graphdbapi.engine.safe

Interface EngineGraph

public interface EngineGraph

图引擎主要接口，提供基础的操作接口。

Since:

3.4.4

Method Summary

Modifier and Type	Method and Description
boolean	containAllSeqId(int seqId) 判断集群点是否存在。
boolean	containLocalSeqId(int seqId) 判断本机点是否存在。
default boolean	containSeqId(int seqId, boolean isLocal) 判断点是否存在。
default long	getAllEdgeCount() 获取集群合法边总数。
default int	getAllVertexCount() 获取集群点总数。
int	getClusterNodeId(int seqId) 获取点的机器号。 当点不存在时会抛出点不存在异常。
long	getEdgeCount(boolean isLocal) 获取合法边总数。
default long	getEdgeCount(int typeIndex) 获取集群给定边类型编号合法边总数。
long	getEdgeCount(int typeIndex, int clusterNodeId) 获取机器号和边类型编号对应的合法边总数。
EngineMetrics	getEngineMetrics() 获取图引擎指标。
java.lang.String	getEngineName() 获取图引擎名。
Graph	getGraph() 获取图操作对象。
IdsMap	getIdsMap() 获取图引擎ID映射器。
long	getLongPrimaryKey(int seqId) 通过点ID获取点主键，配合STRING_TO_LONG使用。
int	getMaxSeqId() 获取最大的点(不包含本身)，其中0 <= seq id < max seq id。
java.lang.String	getPrimaryKey(int seqId) 通过点ID获取点主键。
int	getSeqId(long vertexId) 通过内部ID获取点ID。
int	getVertexCount(boolean isLocal) 获取点总数。
default int	getVertexCount(int typeIndex) 获取点类型对应的点总数。
int	getVertexCount(int typeIndex, int clusterNodeId) 获取特定机器点类型对应的点总数。
long	getVertexId(int seqId) 通过点ID获取内部ID。
int	getVertexTypeIndex(int seqId) 获取点的类型编号。
default EngineVertexIterator	retrieveAllVertexes() 同retrieveAllVertexes(null)。
EngineVertexIterator	retrieveAllVertexes(EngineVertexParam param) 获取集群点迭代器，填null表示过滤不生效。
default void	retrieveAllVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer) 同retrieveAllVertexesParallel(consumer, null)。
void	retrieveAllVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer, EngineVertexParam param) 并行集群点迭代，填null表示过滤不生效。
default int	retrieveDegree(int seqId, Direction direction) 同retrieveDegreeBySeqId(seqId, direction, null)。
int	retrieveDegree(int seqId, Direction direction, EngineEdgeParam param) 检索度数，填null表示过滤不生效。
default EngineEdgeIterator	retrieveEdge(int seqId, Direction direction) 同retrieveEdge(seqId, null)。
EngineEdgeIterator	retrieveEdge(int seqId, Direction direction, EngineEdgeParam param) 检索边，填null表示过滤不生效。
default EngineIdIterator	retrieveEdgeId(int seqId, Direction direction) 同retrieveEdgeId(seqId, direction, null)。
EngineIdIterator	retrieveEdgeId(int seqId, Direction direction, EngineEdgeParam param) 检索边ID，填null表示过滤不生效。
default EngineVertexIterator	retrieveLocalVertexes() 同retrieveLocalVertexes(null)。
EngineVertexIterator	retrieveLocalVertexes(EngineVertexParam param) 检索本机所有点，填null表示过滤不生效。
default void	retrieveLocalVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer) 同retrieveLocalVertexesParallel(consumer, null)。
void	retrieveLocalVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer, EngineVertexParam param) 并行检索本机所有点，填null表示过滤不生效。
boolean	retrieveVertexBooleanProperty(int seqId, java.lang.String propertyName) 通过点ID及点属性名获取点布尔属性，属性不存在或属性值为空返回EngineDataType.BOOLEAN_NULL_VALUE。
byte	retrieveVertexByteProperty(int seqId, java.lang.String propertyName) 通过点ID及点属性名获取点字节属性，属性不存在或属性值为空返回EngineDataType.BYTE_NULL_VALUE。
double	retrieveVertexDecimalProperty(int seqId, java.lang.String propertyName) 通过点ID及点属性名获取点浮点属性，属性不存在或属性值为空返回EngineDataType.DOUBLE_NULL_VALUE。
double	retrieveVertexDoubleProperty(int seqId, java.lang.String propertyName) 通过点ID及点属性名获取点双精度属性，属性不存在或属性值为空返回EngineDataType.DOUBLE_NULL_VALUE。
default EngineVertexIterator	retrieveVertexes(boolean isLocal) 同retrieveVertexes(null, isLocal)。
default EngineVertexIterator	retrieveVertexes(EngineVertexParam param, boolean isLocal) 获取点迭代器，填null表示过滤不生效。
default void	retrieveVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer, boolean isLocal) 同retrieveVertexesParallel(consumer, null, isLocal)。
default void	retrieveVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer, EngineVertexParam param, boolean isLocal) 并行点迭代，填null表示过滤不生效。
long	retrieveVertexIntegerProperty(int seqId, java.lang.String propertyName) 通过点ID及点属性名获取点整数属性，属性不存在或属性值为空返回EngineDataType.LONG_NULL_VALUE。
int	retrieveVertexIntProperty(int seqId, java.lang.String propertyName) 通过点ID及点属性名获取点短整型属性，属性不存在或属性值为空返回EngineDataType.INT_NULL_VALUE。
long	retrieveVertexLongProperty(int seqId, java.lang.String propertyName) 通过点ID及点属性名获取点长整型属性，属性不存在或属性值为空返回EngineDataType.LONG_NULL_VALUE。
double	retrieveVertexNumberProperty(int seqId, java.lang.String propertyName) 通过点ID及点属性名获取点数值属性，属性不存在或属性值为空返回EngineDataType.DOUBLE_NULL_VALUE。
java.util.Map<java.lang.String,java.lang.Object>	retrieveVertexProperties(int seqId) 获取点的全部属性。
java.lang.String	retrieveVertexStringProperty(int seqId, java.lang.String propertyName) 通过点ID及点属性名获取点字符串属性，属性不存在或属性值为空返回EngineDataType.REF_NULL_VALUE。
EngineSchema	schema() 获取图模型。
EngineStartupMeta	startupMeta() 获取启动元信息。

Method Detail

getEngineName

java.lang.String getEngineName()

获取图引擎名。

Returns:

图引擎名。

Since:

3.4.4

getGraph

Graph getGraph()

获取图操作对象。

Returns:

图对象。

Since:

3.4.4

schema

EngineSchema schema()

获取图模型。

Returns:

图模型。

Since:

3.4.4

startupMeta

EngineStartupMeta startupMeta()

获取启动元信息。

Returns:

启动元信息。

Since:

3.4.4

getIdsMap

IdsMap getIdsMap()

获取图引擎ID映射器。

Returns:

ID映射器。

Since:

3.4.4

getEngineMetrics

EngineMetrics getEngineMetrics()

获取图引擎指标。

Returns:

图引擎的指标信息。

Since:

3.4.4

containLocalSeqId

boolean containLocalSeqId(int seqId)

判断本机点是否存在。

Parameters:

seqId - 点ID。

Returns:

true表示点存在，false表示点不存在。

Since:

3.4.4

containAllSeqId

boolean containAllSeqId(int seqId)

判断集群点是否存在。

Parameters:

seqId - 点ID。

Returns:

true表示点存在，false表示点不存在。

Since:

3.4.4

containSeqId

default boolean containSeqId(int seqId,
                             boolean isLocal)

判断点是否存在。

Parameters:

seqId - 点ID。

isLocal - 判断本机点是否存在。

Returns:

true表示点存在，false表示点不存在。

getVertexTypeIndex

int getVertexTypeIndex(int seqId)

获取点的类型编号。

当点不存在时会抛出点不存在异常。

Parameters:

seqId - 点ID。

Returns:

点类型编号。

Since:

3.4.4

getClusterNodeId

int getClusterNodeId(int seqId)

获取点的机器号。 当点不存在时会抛出点不存在异常。

Parameters:

seqId - 点ID。

Returns:

机器号。

Since:

3.4.4

retrieveVertexProperties

java.util.Map<java.lang.String,java.lang.Object> retrieveVertexProperties(int seqId)

获取点的全部属性。

当点不存在时会抛出点不存在异常。

Parameters:

seqId - 点ID。

Returns:

点属性。

Since:

3.4.4

retrieveLocalVertexes

default EngineVertexIterator retrieveLocalVertexes()

同retrieveLocalVertexes(null)。

Returns:

点迭代器。

Since:

3.4.4

retrieveLocalVertexes

EngineVertexIterator retrieveLocalVertexes(EngineVertexParam param)

检索本机所有点，填null表示过滤不生效。

Parameters:

param - 可选参数。

Returns:

点迭代器。

Since:

3.4.4

retrieveLocalVertexesParallel

default void retrieveLocalVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer)
                                    throws java.util.concurrent.ExecutionException,
                                           java.lang.InterruptedException

同retrieveLocalVertexesParallel(consumer, null)。

Parameters:

consumer - 针对每个点进行操作。

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

Since:

3.4.4

retrieveLocalVertexesParallel

void retrieveLocalVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer,
                                   EngineVertexParam param)
                            throws java.util.concurrent.ExecutionException,
                                   java.lang.InterruptedException

并行检索本机所有点，填null表示过滤不生效。

Parameters:

consumer - 针对每个点进行操作。

param - 可选参数。

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

Since:

3.4.4

retrieveAllVertexes

default EngineVertexIterator retrieveAllVertexes()

同retrieveAllVertexes(null)。

Returns:

点迭代器。

Since:

3.4.4

retrieveAllVertexes

EngineVertexIterator retrieveAllVertexes(EngineVertexParam param)

获取集群点迭代器，填null表示过滤不生效。

Parameters:

param - 可选参数。

Returns:

点迭代器。

Since:

3.4.4

retrieveAllVertexesParallel

default void retrieveAllVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer)
                                  throws java.util.concurrent.ExecutionException,
                                         java.lang.InterruptedException

同retrieveAllVertexesParallel(consumer, null)。

Parameters:

consumer - 针对每个点进行操作。

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

Since:

3.4.4

retrieveAllVertexesParallel

void retrieveAllVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer,
                                 EngineVertexParam param)
                          throws java.util.concurrent.ExecutionException,
                                 java.lang.InterruptedException

并行集群点迭代，填null表示过滤不生效。

Parameters:

consumer - 针对每个点进行操作。

param - 可选参数。

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

Since:

3.4.4

retrieveVertexes

default EngineVertexIterator retrieveVertexes(boolean isLocal)

同retrieveVertexes(null, isLocal)。

Parameters:

isLocal - 本机点迭代。

Returns:

点迭代器。

Since:

3.4.4

retrieveVertexes

default EngineVertexIterator retrieveVertexes(EngineVertexParam param,
                                              boolean isLocal)

获取点迭代器，填null表示过滤不生效。

Parameters:

param - 可选参数。

isLocal - 本机点迭代。

Returns:

点迭代器。

Since:

3.4.4

retrieveVertexesParallel

default void retrieveVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer,
                                      boolean isLocal)
                               throws java.util.concurrent.ExecutionException,
                                      java.lang.InterruptedException

同retrieveVertexesParallel(consumer, null, isLocal)。

Parameters:

consumer - 针对每个点进行操作。

isLocal - 本机点迭代。

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

Since:

3.4.4

retrieveVertexesParallel

default void retrieveVertexesParallel(java.util.function.Consumer<EngineVertexIterator> consumer,
                                      EngineVertexParam param,
                                      boolean isLocal)
                               throws java.util.concurrent.ExecutionException,
                                      java.lang.InterruptedException

并行点迭代，填null表示过滤不生效。

Parameters:

consumer - 针对每个点进行操作。

param - 可选参数。

isLocal - 本机点迭代。

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

Since:

3.4.4

getMaxSeqId

int getMaxSeqId()

获取最大的点(不包含本身)，其中0 <= seq id < max seq id。

Returns:

最大的点ID。

Since:

3.4.4

getSeqId

int getSeqId(long vertexId)

通过内部ID获取点ID。

当点不存在时会抛出点不存在异常。

Parameters:

vertexId - 内部ID。

Returns:

点ID。

Since:

3.4.4

getVertexId

long getVertexId(int seqId)

通过点ID获取内部ID。

当点不存在时会抛出点不存在异常。

Parameters:

seqId - 点ID。

Returns:

内部ID。

Since:

3.4.4

getPrimaryKey

java.lang.String getPrimaryKey(int seqId)

通过点ID获取点主键。

当点不存在时会抛出点不存在异常。 当点主键未被存储时会抛出点主键属性不存在异常。

Parameters:

seqId - 点ID。

Returns:

点主键。

Since:

3.4.4

getLongPrimaryKey

long getLongPrimaryKey(int seqId)

通过点ID获取点主键，配合STRING_TO_LONG使用。

当点不存在时会抛出点不存在异常。 当点主键未被存储时会抛出点主键属性不存在异常。

Parameters:

seqId - 点ID。

Returns:

点主键。

Since:

3.4.4

retrieveVertexBooleanProperty

boolean retrieveVertexBooleanProperty(int seqId,
                                      java.lang.String propertyName)

通过点ID及点属性名获取点布尔属性，属性不存在或属性值为空返回EngineDataType.BOOLEAN_NULL_VALUE。

当点不存在时会抛出点不存在异常。 当点属性不存在时会抛出点属性不存在异常。 当点属性非布尔类型时会抛出类型不匹配异常。

Parameters:

seqId - 点ID。

propertyName - 点属性名。

Returns:

点布尔属性。

Since:

3.4.4

retrieveVertexIntProperty

int retrieveVertexIntProperty(int seqId,
                              java.lang.String propertyName)

通过点ID及点属性名获取点短整型属性，属性不存在或属性值为空返回EngineDataType.INT_NULL_VALUE。

当点不存在时会抛出点不存在异常。 当点属性不存在时会抛出点属性不存在异常。 当点属性非短整型类型时会抛出类型不匹配异常。

Parameters:

seqId - 点ID。

propertyName - 点属性名。

Returns:

点短整型属性。

Since:

3.4.4

retrieveVertexLongProperty

long retrieveVertexLongProperty(int seqId,
                                java.lang.String propertyName)

通过点ID及点属性名获取点长整型属性，属性不存在或属性值为空返回EngineDataType.LONG_NULL_VALUE。

当点不存在时会抛出点不存在异常。 当点属性不存在时会抛出点属性不存在异常。 当点属性非长整型类型时会抛出类型不匹配异常。

Parameters:

seqId - 点ID。

propertyName - 点属性名。

Returns:

点长整型属性。

Since:

3.4.4

retrieveVertexDoubleProperty

double retrieveVertexDoubleProperty(int seqId,
                                    java.lang.String propertyName)

通过点ID及点属性名获取点双精度属性，属性不存在或属性值为空返回EngineDataType.DOUBLE_NULL_VALUE。

当点不存在时会抛出点不存在异常。 当点属性不存在时会抛出点属性不存在异常。 当点属性非双精度类型时会抛出类型不匹配异常。

Parameters:

seqId - 点ID。

propertyName - 点属性名。

Returns:

点双精度属性。

Since:

3.4.4

retrieveVertexStringProperty

java.lang.String retrieveVertexStringProperty(int seqId,
                                              java.lang.String propertyName)

通过点ID及点属性名获取点字符串属性，属性不存在或属性值为空返回EngineDataType.REF_NULL_VALUE。

当点不存在时会抛出点不存在异常。 当点属性不存在时会抛出点属性不存在异常。 当点属性非字符串类型时会抛出类型不匹配异常。

Parameters:

seqId - 点ID。

propertyName - 点属性名。

Returns:

点字符串属性。

Since:

3.4.4

retrieveVertexIntegerProperty

long retrieveVertexIntegerProperty(int seqId,
                                   java.lang.String propertyName)

通过点ID及点属性名获取点整数属性，属性不存在或属性值为空返回EngineDataType.LONG_NULL_VALUE。

当点不存在时会抛出点不存在异常。 当点属性不存在时会抛出点属性不存在异常。 当点属性非整数类型时会抛出类型不匹配异常。

Parameters:

seqId - 点ID。

propertyName - 点属性名。

Returns:

点整数属性。

Since:

3.4.4

retrieveVertexDecimalProperty

double retrieveVertexDecimalProperty(int seqId,
                                     java.lang.String propertyName)

通过点ID及点属性名获取点浮点属性，属性不存在或属性值为空返回EngineDataType.DOUBLE_NULL_VALUE。

当点不存在时会抛出点不存在异常。 当点属性不存在时会抛出点属性不存在异常。 当点属性非浮点类型时会抛出类型不匹配异常。

Parameters:

seqId - 点ID。

propertyName - 点属性名。

Returns:

点浮点属性。

Since:

3.4.4

retrieveVertexNumberProperty

double retrieveVertexNumberProperty(int seqId,
                                    java.lang.String propertyName)

通过点ID及点属性名获取点数值属性，属性不存在或属性值为空返回EngineDataType.DOUBLE_NULL_VALUE。

当点不存在时会抛出点不存在异常。 当点属性不存在时会抛出点属性不存在异常。 当点属性非数值类型时会抛出类型不匹配异常。

Parameters:

seqId - 点ID。

propertyName - 点属性名。

Returns:

点数值属性。

Since:

3.4.4

retrieveVertexByteProperty

byte retrieveVertexByteProperty(int seqId,
                                java.lang.String propertyName)

通过点ID及点属性名获取点字节属性，属性不存在或属性值为空返回EngineDataType.BYTE_NULL_VALUE。

当点不存在时会抛出点不存在异常。 当点属性不存在时会抛出点属性不存在异常。 当点属性非字节类型时会抛出类型不匹配异常。

Parameters:

seqId - 点ID。

propertyName - 点属性名。

Returns:

点byte属性。

Since:

3.4.4

getAllVertexCount

default int getAllVertexCount()

获取集群点总数。

Returns:

合法点总数。

Since:

3.4.4

getVertexCount

int getVertexCount(boolean isLocal)

获取点总数。

Parameters:

isLocal - true表示本机，false表示集群。

Returns:

合法点总数。

Since:

3.4.4

getVertexCount

default int getVertexCount(int typeIndex)

获取点类型对应的点总数。

Parameters:

typeIndex - 点类型编号。

Returns:

合法点总数。

Since:

3.4.4

getVertexCount

int getVertexCount(int typeIndex,
                   int clusterNodeId)

获取特定机器点类型对应的点总数。

Parameters:

typeIndex - 点类型编号。

clusterNodeId - 机器号。

Returns:

合法点总数。

Since:

3.4.4

retrieveEdge

default EngineEdgeIterator retrieveEdge(int seqId,
                                        Direction direction)

同retrieveEdge(seqId, null)。

Parameters:

seqId - 点ID。

direction - 检索方向。

Returns:

边迭代器。

Since:

3.4.4

retrieveEdge

EngineEdgeIterator retrieveEdge(int seqId,
                                Direction direction,
                                EngineEdgeParam param)

检索边，填null表示过滤不生效。

Parameters:

seqId - 点ID。

direction - 检索方向。

param - 可选参数。

Returns:

边迭代器。

Since:

3.4.4

retrieveDegree

default int retrieveDegree(int seqId,
                           Direction direction)

同retrieveDegreeBySeqId(seqId, direction, null)。

Parameters:

seqId - 点ID。

direction - 检索方向。

Returns:

度数。

Since:

3.4.4

retrieveDegree

int retrieveDegree(int seqId,
                   Direction direction,
                   EngineEdgeParam param)

检索度数，填null表示过滤不生效。

Parameters:

seqId - 点ID。

direction - 检索方向。

param - 可选参数。

Returns:

度数。

Since:

3.4.4

getAllEdgeCount

default long getAllEdgeCount()

获取集群合法边总数。

Returns:

合法边总数。

Since:

3.4.4

getEdgeCount

long getEdgeCount(boolean isLocal)

获取合法边总数。

Parameters:

isLocal - 本机。

Returns:

合法边总数。

Since:

3.4.4

getEdgeCount

default long getEdgeCount(int typeIndex)

获取集群给定边类型编号合法边总数。

Parameters:

typeIndex - 边类型编号。

Returns:

合法边总数。

Since:

3.4.4

getEdgeCount

long getEdgeCount(int typeIndex,
                  int clusterNodeId)

获取机器号和边类型编号对应的合法边总数。

Parameters:

typeIndex - 边类型编号。

clusterNodeId - 机器号。

Returns:

合法边总数。

Since:

3.4.4

retrieveEdgeId

default EngineIdIterator retrieveEdgeId(int seqId,
                                        Direction direction)

同retrieveEdgeId(seqId, direction, null)。

Parameters:

seqId - 点ID。

direction - 检索方向。

Returns:

边ID迭代器。

Since:

3.4.4

retrieveEdgeId

EngineIdIterator retrieveEdgeId(int seqId,
                                Direction direction,
                                EngineEdgeParam param)

检索边ID，填null表示过滤不生效。

Parameters:

seqId - 点ID。

direction - 检索方向。

param - 可选参数。

Returns:

边ID迭代器。

Since:

3.4.4