Package org.jgrapht.io

Class GraphMLExporter<V,​E>

  • Type Parameters:
    V - the graph vertex type
    E - the graph edge type
    All Implemented Interfaces:
    GraphExporter<V,​E>
    @Deprecated
public class GraphMLExporter<V,​E>
extends java.lang.Object
implements GraphExporter<V,​E>
    Deprecated.
    Deprecated in favor of GraphMLExporter.
    Exports a graph as GraphML.

    For a description of the format see http://en.wikipedia.org/wiki/ GraphML.

    Author:
    Trevor Harmon, Dimitrios Michail

    • Field Detail

      • vertexIDProvider

        protected ComponentNameProvider<V> vertexIDProvider
        Deprecated.
        Provides an identifier for a vertex.

      • edgeIDProvider

        protected ComponentNameProvider<E> edgeIDProvider
        Deprecated.
        Provides an identifier for an edge.

    • Constructor Detail

      • GraphMLExporter

        public GraphMLExporter()
        Deprecated.
        Constructs a new GraphMLExporter with integer name providers for the vertex and edge identifiers.

      • GraphMLExporter

        public GraphMLExporter​(ComponentNameProvider<V> vertexIDProvider,
                       ComponentNameProvider<V> vertexLabelProvider,
                       ComponentNameProvider<E> edgeIDProvider,
                       ComponentNameProvider<E> edgeLabelProvider)
        Deprecated.
        Constructs a new GraphMLExporter.
        Parameters:
        vertexIDProvider - for generating vertex identifiers. Must not be null.
        vertexLabelProvider - for generating vertex labels. If null, vertex labels will not exported.
        edgeIDProvider - for generating edge identifiers. Must not be null.
        edgeLabelProvider - for generating edge labels. If null, edge labels will not be exported.

      • GraphMLExporter

        public GraphMLExporter​(ComponentNameProvider<V> vertexIDProvider,
                       ComponentNameProvider<V> vertexLabelProvider,
                       ComponentAttributeProvider<V> vertexAttributeProvider,
                       ComponentNameProvider<E> edgeIDProvider,
                       ComponentNameProvider<E> edgeLabelProvider,
                       ComponentAttributeProvider<E> edgeAttributeProvider)
        Deprecated.
        Constructs a new GraphMLExporter.
        Parameters:
        vertexIDProvider - for generating vertex identifiers. Must not be null.
        vertexLabelProvider - for generating vertex labels. If null, vertex labels will not exported.
        vertexAttributeProvider - for generating vertex attributes. If null, no additional attributes will be exported.
        edgeIDProvider - for generating edge identifiers. Must not be null.
        edgeLabelProvider - for generating edge labels. If null, edge labels will not be exported.
        edgeAttributeProvider - for generating edge attributes. If null, no additional attributes will be exported.

    • Method Detail

      • registerAttribute

        public void registerAttribute​(java.lang.String name,
                              GraphMLExporter.AttributeCategory category,
                              AttributeType type)
        Deprecated.
        Register a GraphML-Attribute
        Parameters:
        name - the attribute name
        category - the attribute category
        type - the attribute type

      • registerAttribute

        public void registerAttribute​(java.lang.String name,
                              GraphMLExporter.AttributeCategory category,
                              AttributeType type,
                              java.lang.String defaultValue)
        Deprecated.
        Register a GraphML-Attribute
        Parameters:
        name - the attribute name
        category - the attribute category
        type - the attribute type
        defaultValue - default value

      • unregisterAttribute

        public void unregisterAttribute​(java.lang.String name)
        Deprecated.
        Unregister a GraphML-Attribute
        Parameters:
        name - the attribute name

      • isExportEdgeWeights

        public boolean isExportEdgeWeights()
        Deprecated.
        Whether the exporter will print edge weights.
        Returns:
        true if the exporter prints edge weights, false otherwise

      • setExportEdgeWeights

        public void setExportEdgeWeights​(boolean exportEdgeWeights)
        Deprecated.
        Set whether the exporter will print edge weights.
        Parameters:
        exportEdgeWeights - value to set

      • getVertexLabelAttributeName

        public java.lang.String getVertexLabelAttributeName()
        Deprecated.
        Get the attribute name for vertex labels
        Returns:
        the attribute name

      • setVertexLabelAttributeName

        public void setVertexLabelAttributeName​(java.lang.String vertexLabelAttributeName)
        Deprecated.
        Set the attribute name to use for vertex labels.
        Parameters:
        vertexLabelAttributeName - the attribute name

      • getEdgeLabelAttributeName

        public java.lang.String getEdgeLabelAttributeName()
        Deprecated.
        Get the attribute name for edge labels
        Returns:
        the attribute name

      • setEdgeLabelAttributeName

        public void setEdgeLabelAttributeName​(java.lang.String edgeLabelAttributeName)
        Deprecated.
        Set the attribute name to use for edge labels.
        Parameters:
        edgeLabelAttributeName - the attribute name

      • getEdgeWeightAttributeName

        public java.lang.String getEdgeWeightAttributeName()
        Deprecated.
        Get the attribute name for edge weights
        Returns:
        the attribute name

      • setEdgeWeightAttributeName

        public void setEdgeWeightAttributeName​(java.lang.String edgeWeightAttributeName)
        Deprecated.
        Set the attribute name to use for edge weights.
        Parameters:
        edgeWeightAttributeName - the attribute name

      • getVertexLabelProvider

        public ComponentNameProvider<V> getVertexLabelProvider()
        Deprecated.
        Get the vertex label provider
        Returns:
        the vertex label provider

      • setVertexLabelProvider

        public void setVertexLabelProvider​(ComponentNameProvider<V> vertexLabelProvider)
        Deprecated.
        Set the vertex label provider.
        Parameters:
        vertexLabelProvider - the vertex label provider to set

      • getEdgeLabelProvider

        public ComponentNameProvider<E> getEdgeLabelProvider()
        Deprecated.
        Get the edge label provider
        Returns:
        the edge label provider

      • setEdgeLabelProvider

        public void setEdgeLabelProvider​(ComponentNameProvider<E> edgeLabelProvider)
        Deprecated.
        Set the edge label provider.
        Parameters:
        edgeLabelProvider - the edge label provider to set

      • getVertexAttributeProvider

        public ComponentAttributeProvider<V> getVertexAttributeProvider()
        Deprecated.
        Get the vertex attribute provider
        Returns:
        the vertex attribute provider

      • setVertexAttributeProvider

        public void setVertexAttributeProvider​(ComponentAttributeProvider<V> vertexAttributeProvider)
        Deprecated.
        Set the vertex attribute provider.
        Parameters:
        vertexAttributeProvider - the vertex attribute provider to set

      • getEdgeAttributeProvider

        public ComponentAttributeProvider<E> getEdgeAttributeProvider()
        Deprecated.
        Get the edge attribute provider
        Returns:
        the edge attribute provider

      • setEdgeAttributeProvider

        public void setEdgeAttributeProvider​(ComponentAttributeProvider<E> edgeAttributeProvider)
        Deprecated.
        Set the edge attribute provider.
        Parameters:
        edgeAttributeProvider - the edge attribute provider to set

      • exportGraph

        public void exportGraph​(org.jgrapht.Graph<V,​E> g,
                        java.io.Writer writer)
                 throws ExportException
        Deprecated.
        Exports a graph in GraphML format.
        Specified by:
        exportGraph in interface GraphExporter<V,​E>
        Parameters:
        g - the graph
        writer - the writer to export the graph
        Throws:
        ExportException - in case any error occurs during export

      • getVertexIDProvider

        public ComponentNameProvider<V> getVertexIDProvider()
        Deprecated.
        Get the vertex id provider
        Returns:
        the vertex id provider

      • setVertexIDProvider

        public void setVertexIDProvider​(ComponentNameProvider<V> vertexIDProvider)
        Deprecated.
        Set the vertex id provider
        Parameters:
        vertexIDProvider - the new vertex id provider. Must not be null.

      • getEdgeIDProvider

        public ComponentNameProvider<E> getEdgeIDProvider()
        Deprecated.
        Get the edge id provider
        Returns:
        The edge provider

      • setEdgeIDProvider

        public void setEdgeIDProvider​(ComponentNameProvider<E> edgeIDProvider)
        Deprecated.
        Set the edge id provider.
        Parameters:
        edgeIDProvider - the new edge id provider. Must not be null.