Package oracle.pgx.api

Class GraphMetaData

  • public class GraphMetaData
extends oracle.pgx.common.Self
    Meta information about PgxGraph.

    • Constructor Detail

      • GraphMetaData

        public GraphMetaData​(IdType vertexIdType,
                     IdType edgeIdType)

    • Method Detail

      • 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.

      • getVertexProvidersMetaData

        public java.util.Map<java.lang.String,​VertexProviderMetaData> getVertexProvidersMetaData()
        Gets the vertex tables metadata
        Returns:
        a map from vertex table name to its metadata

      • setVertexProvidersMetaData

        public void setVertexProvidersMetaData​(java.util.Map<java.lang.String,​VertexProviderMetaData> vertexProviderMetaDataMap)
        Set the vertex tables metadata

      • getEdgeProvidersMetaData

        public java.util.Map<java.lang.String,​EdgeProviderMetaData> getEdgeProvidersMetaData()
        Gets the edge tables metadata
        Returns:
        a map from edge table name to its metadata

      • setEdgeProvidersMetaData

        public void setEdgeProvidersMetaData​(java.util.Map<java.lang.String,​EdgeProviderMetaData> edgeProviderMetaDataMap)
        Sets the edge tables metadata

      • getNumVertices

        public long getNumVertices()
        Gets the number of vertices
        Returns:
        the numVertices

      • setNumVertices

        public void setNumVertices​(long numVertices)
        Parameters:
        numVertices - the numVertices to set

      • getNumEdges

        public long getNumEdges()
        Gets the number of edges
        Returns:
        the numEdges

      • setNumEdges

        public void setNumEdges​(long numEdges)
        Parameters:
        numEdges - the numEdges to set

      • getMemoryMb

        public long getMemoryMb()
        Gets the estimated number of memory this graph (including its properties) consumes in memory (in megabytes).
        Returns:
        the memoryMb

      • setMemoryMb

        public void setMemoryMb​(long memoryMb)
        Parameters:
        memoryMb - the memoryMb to set

      • 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.

      • setDataSourceVersion

        public void setDataSourceVersion​(java.lang.String dataSourceVersion)
        Parameters:
        dataSourceVersion - the dataSourceVersion to set

      • 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.

      • setConfig

        public void setConfig​(GraphConfig config)
        Parameters:
        config - the GraphConfig object to set for this GraphMetaData object

      • getCreationRequestTimestamp

        public long getCreationRequestTimestamp()
        Gets the timestamp (milliseconds since Jan 1st 1970) when this graph was requested to be created.
        Returns:
        the creationRequestTimestamp

      • setCreationRequestTimestamp

        public void setCreationRequestTimestamp​(long creationRequestTimestamp)
        Parameters:
        creationRequestTimestamp - the creationRequestTimestamp to set

      • getCreationTimestamp

        public long getCreationTimestamp()
        Gets the timestamp (milliseconds since Jan 1st 1970) when this graph finished creation.
        Returns:
        the creationTimestamp

      • setCreationTimestamp

        public void setCreationTimestamp​(long creationTimestamp)
        Parameters:
        creationTimestamp - the creationTimestamp to set

      • getVertexIdStrategy

        public IdStrategy getVertexIdStrategy()
        Gets the ID strategy used for the vertices of this graph.
        Returns:
        the vertex id strategy

      • setVertexIdStrategy

        public void setVertexIdStrategy​(IdStrategy idStrategy)

      • getVertexIdType

        public IdType getVertexIdType()
        Gets the vertex ID type of this graph.
        Returns:
        the vertexIdType

      • getEdgeIdStrategy

        public IdStrategy getEdgeIdStrategy()
        Gets the ID strategy used for the edges of this graph.
        Returns:
        the vertex id strategy

      • setEdgeIdStrategy

        public void setEdgeIdStrategy​(IdStrategy idStrategy)

      • getEdgeIdType

        public IdType getEdgeIdType()
        Gets the edge ID type of this graph.
        Returns:
        the edgeIdType

      • isDirected

        public boolean isDirected()
        Returns if the graph is directed.

      • setDirected

        public void setDirected​(boolean directed)
        Parameters:
        directed -

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • isGraphPinned

        public boolean isGraphPinned()

      • setGraphPinned

        public void setGraphPinned​(boolean pinned)

      • isSnapshotPinned

        public boolean isSnapshotPinned()

      • setSnapshotPinned

        public void setSnapshotPinned​(boolean snapshotPinned)