oracle.pgx.api

Class GraphMetaData

java.lang.Object

oracle.pgx.common.Self

oracle.pgx.api.GraphMetaData

public class GraphMetaData
extends oracle.pgx.common.Self

Meta information about PgxGraph.

Constructor Summary

Constructors

Constructor and Description
GraphMetaData() Deprecated.
GraphMetaData(GraphMetaData other)
GraphMetaData(GraphMetaData other, java.net.URI baseUri) Deprecated.
GraphMetaData(IdType vertexIdType) Deprecated.
GraphMetaData(IdType vertexIdType, IdType edgeIdType)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
GraphConfig	getConfig() Gets the graph configuration object used to specify the data source of this graph.
long	getCreationRequestTimestamp() Gets the timestamp (milliseconds since Jan 1st 1970) when this graph was requested to be created.
long	getCreationTimestamp() Gets the timestamp (milliseconds since Jan 1st 1970) when this graph finished creation.
java.lang.String	getDataSourceVersion() Gets the format-specific version identifier provided by the data-source.
IdStrategy	getEdgeIdStrategy() Gets the ID strategy used for the edges of this graph.
IdType	getEdgeIdType() Gets the edge ID type of this graph.
java.util.Map<java.lang.String,EdgeTableMetaData>	getEdgeTableMetaDataMap() Gets the edge tables metadata
EdgeTableMetaData	getMainEdgeTableMetaData()
VertexTableMetaData	getMainVertexTableMetaData()
long	getMemoryMb() Gets the estimated number of memory this graph (including its properties) consumes in memory (in megabytes).
long	getNumEdges() Gets the number of edges
long	getNumVertices() Gets the number of vertices
IdStrategy	getVertexIdStrategy() Gets the ID strategy used for the vertices of this graph.
IdType	getVertexIdType() Gets the vertex ID type of this graph.
java.util.Map<java.lang.String,VertexTableMetaData>	getVertexTableMetaDataMap() Gets the vertex tables metadata
int	hashCode()
boolean	isDirected() Returns if the graph is directed.
boolean	isPartitioned() Returns if the graph is partitioned or not.
void	setConfig(GraphConfig config)
void	setCreationRequestTimestamp(long creationRequestTimestamp)
void	setCreationTimestamp(long creationTimestamp)
void	setDataSourceVersion(java.lang.String dataSourceVersion)
void	setDirected(boolean directed)
void	setEdgeIdStrategy(IdStrategy idStrategy)
void	setEdgeIdType(IdType edgeIdType)
void	setEdgeTableMetaDataMap(java.util.Map<java.lang.String,EdgeTableMetaData> edgeTableMetaDataMap) Sets the edge tables metadata
void	setMemoryMb(long memoryMb)
void	setNumEdges(long numEdges)
void	setNumVertices(long numVertices)
void	setVertexIdStrategy(IdStrategy idStrategy)
void	setVertexIdType(IdType vertexIdType)
void	setVertexTableMetaDataMap(java.util.Map<java.lang.String,VertexTableMetaData> vertexTableMetaDataMap) Set the vertex tables metadata
java.lang.String	toString()

Methods inherited from class oracle.pgx.common.Self

addLinks, getCanonicalLink, getId, getLinks, injectLinks, setId, setLinks

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GraphMetaData

@Deprecated
public GraphMetaData()

Deprecated.

GraphMetaData

public GraphMetaData(GraphMetaData other)

GraphMetaData

@Deprecated
public GraphMetaData(GraphMetaData other,
                                 java.net.URI baseUri)

Deprecated.

GraphMetaData

@Deprecated
public GraphMetaData(IdType vertexIdType)

Deprecated.

GraphMetaData

public GraphMetaData(IdType vertexIdType,
                     IdType edgeIdType)

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getConfig

public GraphConfig getConfig()

Gets the graph configuration object used to specify the data source of this graph.

Returns:

the config. Can be null if graph was not created from a datasource.

getCreationRequestTimestamp

public long getCreationRequestTimestamp()

Gets the timestamp (milliseconds since Jan 1st 1970) when this graph was requested to be created.

Returns:

the creationRequestTimestamp

getCreationTimestamp

public long getCreationTimestamp()

Gets the timestamp (milliseconds since Jan 1st 1970) when this graph finished creation.

Returns:

the creationTimestamp

getDataSourceVersion

public java.lang.String getDataSourceVersion()

Gets the format-specific version identifier provided by the data-source.

Returns:

the dataSourceVersion. Can be null if graph was not created from a datasource.

getEdgeIdStrategy

public IdStrategy getEdgeIdStrategy()

Gets the ID strategy used for the edges of this graph.

Returns:

the vertex id strategy

getEdgeIdType

public IdType getEdgeIdType()

Gets the edge ID type of this graph.

Returns:

the edgeIdType

getEdgeTableMetaDataMap

public java.util.Map<java.lang.String,EdgeTableMetaData> getEdgeTableMetaDataMap()

Gets the edge tables metadata

Returns:

a map from edge table name to its metadata

getMainEdgeTableMetaData

public EdgeTableMetaData getMainEdgeTableMetaData()

getMainVertexTableMetaData

public VertexTableMetaData getMainVertexTableMetaData()

getMemoryMb

public long getMemoryMb()

Gets the estimated number of memory this graph (including its properties) consumes in memory (in megabytes).

Returns:

the memoryMb

getNumEdges

public long getNumEdges()

Gets the number of edges

Returns:

the numEdges

getNumVertices

public long getNumVertices()

Gets the number of vertices

Returns:

the numVertices

getVertexIdStrategy

public IdStrategy getVertexIdStrategy()

Gets the ID strategy used for the vertices of this graph.

Returns:

the vertex id strategy

getVertexIdType

public IdType getVertexIdType()

Gets the vertex ID type of this graph.

Returns:

the vertexIdType

getVertexTableMetaDataMap

public java.util.Map<java.lang.String,VertexTableMetaData> getVertexTableMetaDataMap()

Gets the vertex tables metadata

Returns:

a map from vertex table name to its metadata

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isDirected

public boolean isDirected()

Returns if the graph is directed.

isPartitioned

public boolean isPartitioned()

Returns if the graph is partitioned or not. The graph has to be considered partitioned if it has more than one vertex/edge table or we have only one table of each type but not the default names.

Returns:

true if this graph is partitioned, false otherwise.

setConfig

public void setConfig(GraphConfig config)

Parameters:

config - the GraphConfig object to set for this GraphMetaData object

setCreationRequestTimestamp

public void setCreationRequestTimestamp(long creationRequestTimestamp)

Parameters:

creationRequestTimestamp - the creationRequestTimestamp to set

setCreationTimestamp

public void setCreationTimestamp(long creationTimestamp)

Parameters:

creationTimestamp - the creationTimestamp to set

setDataSourceVersion

public void setDataSourceVersion(java.lang.String dataSourceVersion)

Parameters:

dataSourceVersion - the dataSourceVersion to set

setDirected

public void setDirected(boolean directed)

Parameters:

directed -

setEdgeIdStrategy

public void setEdgeIdStrategy(IdStrategy idStrategy)

setEdgeIdType

public void setEdgeIdType(IdType edgeIdType)

Parameters:

edgeIdType - the edgeIdType to set

setEdgeTableMetaDataMap

public void setEdgeTableMetaDataMap(java.util.Map<java.lang.String,EdgeTableMetaData> edgeTableMetaDataMap)

Sets the edge tables metadata

setMemoryMb

public void setMemoryMb(long memoryMb)

Parameters:

memoryMb - the memoryMb to set

setNumEdges

public void setNumEdges(long numEdges)

Parameters:

numEdges - the numEdges to set

setNumVertices

public void setNumVertices(long numVertices)

Parameters:

numVertices - the numVertices to set

setVertexIdStrategy

public void setVertexIdStrategy(IdStrategy idStrategy)

setVertexIdType

public void setVertexIdType(IdType vertexIdType)

Parameters:

vertexIdType - the vertexIdType to set

setVertexTableMetaDataMap

public void setVertexTableMetaDataMap(java.util.Map<java.lang.String,VertexTableMetaData> vertexTableMetaDataMap)

Set the vertex tables metadata

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object