Package org.graphstream.stream.file

Class FileSinkSVG

java.lang.Object
org.graphstream.stream.file.FileSinkSVG
All Implemented Interfaces:
AttributeSink, ElementSink, FileSink, Sink
public class FileSinkSVG
extends Object
implements FileSink

  • Constructor Details

  • Method Details

    • begin

      public void begin​(String fileName) throws IOException
      Description copied from interface: FileSink
      Begin the output of the given stream of graph events. The graph events can come from any input (implementation of Source or you can directly use the methods inherited from Sink. Once the writing is started using begin(), you must close it using FileSink.end() when done to ensure data is correctly stored in the file.
      Specified by:
      begin in interface FileSink
      Parameters:
      fileName - The name of the file where to output the graph events.
      Throws:
      IOException - If an I/O error occurs while writing.

    • begin

      public void begin​(OutputStream stream) throws IOException
      Description copied from interface: FileSink
      Begin the output of the given stream of graph events. The graph events can come from any input (implementation of Source or you can directly use the methods inherited from Sink. Once the writing is started using begin(), you must close it using FileSink.end() when done to ensure data is correctly stored in the file.
      Specified by:
      begin in interface FileSink
      Parameters:
      stream - The file stream where to output the graph events.
      Throws:
      IOException - If an I/O error occurs while writing.

    • begin

      public void begin​(Writer writer) throws IOException
      Description copied from interface: FileSink
      Begin the output of the given stream of graph events. The graph events can come from any input (implementation of Source or you can directly use the methods inherited from Sink. Once the writing is started using begin(), you must close it using FileSink.end() when done to ensure data is correctly stored in the file.
      Specified by:
      begin in interface FileSink
      Parameters:
      writer - The writer where to output the graph events.
      Throws:
      IOException - If an I/O error occurs while writing.

    • end

      public void end() throws IOException
      Description copied from interface: FileSink
      End the writing process started with FileSink.begin(OutputStream) or FileSink.begin(String).
      Specified by:
      end in interface FileSink
      Throws:
      IOException

    • flush

      public void flush() throws IOException
      Description copied from interface: FileSink
      Ensure all data sent to the output are correctly written.
      Specified by:
      flush in interface FileSink
      Throws:
      IOException - If an I/O error occurs during write.

    • writeAll

      public void writeAll​(Graph graph, String fileName) throws IOException
      Description copied from interface: FileSink
      Write the current graph state in one big non-interruptible operation. This operation is a "snapshot" of the graph, it will never convey the dynamics of the graph. To ensure you store the graph "as it evolves in time" you must use the FileSink.begin(OutputStream) or FileSink.begin(String) as soon as the graph appears (or any source of graph event, any descendant of Source will do).
      Specified by:
      writeAll in interface FileSink
      Parameters:
      graph - The graph to send as events to the file.
      fileName - Name of the file to write.
      Throws:
      IOException - if an I/O error occurs while writing.

    • writeAll

      public void writeAll​(Graph graph, OutputStream stream) throws IOException
      Description copied from interface: FileSink
      Write the current graph state in one big non-interruptible operation. This operation is a "snapshot" of the graph, it will never convey the dynamics of the graph. To ensure you store the graph "as it evolves in time" you must use the FileSink.begin(Writer) or FileSink.begin(OutputStream) or FileSink.begin(String) as soon as the graph appears (or any source of graph event, any descendant of Source will do).
      Specified by:
      writeAll in interface FileSink
      Parameters:
      graph - The graph to send as events to the file.
      stream - The stream where the graph is sent.
      Throws:
      IOException - if an I/O error occurs while writing.

    • writeAll

      public void writeAll​(Graph g, Writer w) throws IOException
      Description copied from interface: FileSink
      Write the current graph state in one big non-interruptible operation. This operation is a "snapshot" of the graph, it will never convey the dynamics of the graph. To ensure you store the graph "as it evolves in time" you must use the FileSink.begin(Writer) or FileSink.begin(OutputStream) or FileSink.begin(String) as soon as the graph appears (or any source of graph event, any descendant of Source will do).
      Specified by:
      writeAll in interface FileSink
      Parameters:
      g - The graph to send as events to the file.
      w - The writer where the graph is sent.
      Throws:
      IOException - if an I/O error occurs while writing.

    • edgeAttributeAdded

      public void edgeAttributeAdded​(String sourceId, long timeId, String edgeId, String attribute, Object value)
      Description copied from interface: AttributeSink
      A edge attribute was added.
      Specified by:
      edgeAttributeAdded in interface AttributeSink
      Parameters:
      sourceId - Identifier of the graph where the change occurred.
      edgeId - Identifier of the edge whose attribute changed.
      attribute - The attribute name.
      value - The attribute new value.

    • edgeAttributeChanged

      public void edgeAttributeChanged​(String sourceId, long timeId, String edgeId, String attribute, Object oldValue, Object newValue)
      Description copied from interface: AttributeSink
      A edge attribute was changed.
      Specified by:
      edgeAttributeChanged in interface AttributeSink
      Parameters:
      sourceId - Identifier of the graph where the change occurred.
      edgeId - Identifier of the edge whose attribute changed.
      attribute - The attribute name.
      oldValue - The attribute old value.
      newValue - The attribute new value.

    • edgeAttributeRemoved

      public void edgeAttributeRemoved​(String sourceId, long timeId, String edgeId, String attribute)
      Description copied from interface: AttributeSink
      A edge attribute was removed.
      Specified by:
      edgeAttributeRemoved in interface AttributeSink
      Parameters:
      sourceId - Identifier of the graph where the attribute was removed.
      edgeId - Identifier of the edge whose attribute was removed.
      attribute - The removed attribute name.

    • graphAttributeAdded

      public void graphAttributeAdded​(String sourceId, long timeId, String attribute, Object value)
      Description copied from interface: AttributeSink
      A graph attribute was added.
      Specified by:
      graphAttributeAdded in interface AttributeSink
      Parameters:
      sourceId - Identifier of the graph where the attribute changed.
      attribute - The attribute name.
      value - The attribute new value.

    • graphAttributeChanged

      public void graphAttributeChanged​(String sourceId, long timeId, String attribute, Object oldValue, Object newValue)
      Description copied from interface: AttributeSink
      A graph attribute was changed.
      Specified by:
      graphAttributeChanged in interface AttributeSink
      Parameters:
      sourceId - Identifier of the graph where the attribute changed.
      attribute - The attribute name.
      oldValue - The attribute old value.
      newValue - The attribute new value.

    • graphAttributeRemoved

      public void graphAttributeRemoved​(String sourceId, long timeId, String attribute)
      Description copied from interface: AttributeSink
      A graph attribute was removed.
      Specified by:
      graphAttributeRemoved in interface AttributeSink
      Parameters:
      sourceId - Identifier of the graph where the attribute was removed.
      attribute - The removed attribute name.

    • nodeAttributeAdded

      public void nodeAttributeAdded​(String sourceId, long timeId, String nodeId, String attribute, Object value)
      Description copied from interface: AttributeSink
      A node attribute was added.
      Specified by:
      nodeAttributeAdded in interface AttributeSink
      Parameters:
      sourceId - Identifier of the graph where the change occurred.
      nodeId - Identifier of the node whose attribute changed.
      attribute - The attribute name.
      value - The attribute new value.

    • nodeAttributeChanged

      public void nodeAttributeChanged​(String sourceId, long timeId, String nodeId, String attribute, Object oldValue, Object newValue)
      Description copied from interface: AttributeSink
      A node attribute was changed.
      Specified by:
      nodeAttributeChanged in interface AttributeSink
      Parameters:
      sourceId - Identifier of the graph where the change occurred.
      nodeId - Identifier of the node whose attribute changed.
      attribute - The attribute name.
      oldValue - The attribute old value.
      newValue - The attribute new value.

    • nodeAttributeRemoved

      public void nodeAttributeRemoved​(String sourceId, long timeId, String nodeId, String attribute)
      Description copied from interface: AttributeSink
      A node attribute was removed.
      Specified by:
      nodeAttributeRemoved in interface AttributeSink
      Parameters:
      sourceId - Identifier of the graph where the attribute was removed.
      nodeId - Identifier of the node whose attribute was removed.
      attribute - The removed attribute name.

    • edgeAdded

      public void edgeAdded​(String sourceId, long timeId, String edgeId, String fromNodeId, String toNodeId, boolean directed)
      Description copied from interface: ElementSink
      An edge was inserted in graph.
      Specified by:
      edgeAdded in interface ElementSink
      Parameters:
      sourceId - Identifier of the graph where the edge was added.
      edgeId - Identifier of the added edge.
      fromNodeId - Identifier of the first node of the edge.
      toNodeId - Identifier of the second node of the edge.
      directed - If true, the edge is directed.

    • edgeRemoved

      public void edgeRemoved​(String sourceId, long timeId, String edgeId)
      Description copied from interface: ElementSink
      An edge of graph was removed.The nodes the edge connects may already have been removed from the graph.
      Specified by:
      edgeRemoved in interface ElementSink
      Parameters:
      sourceId - The graph where the edge will be removed.
      edgeId - The edge that will be removed.

    • graphCleared

      public void graphCleared​(String sourceId, long timeId)
      Description copied from interface: ElementSink
      The whole graph was cleared. All the nodes, edges and attributes of the graph are removed.
      Specified by:
      graphCleared in interface ElementSink
      Parameters:
      sourceId - The graph cleared.

    • nodeAdded

      public void nodeAdded​(String sourceId, long timeId, String nodeId)
      Description copied from interface: ElementSink
      A node was inserted in the given graph.
      Specified by:
      nodeAdded in interface ElementSink
      Parameters:
      sourceId - Identifier of the graph where the node was added.
      nodeId - Identifier of the added node.

    • nodeRemoved

      public void nodeRemoved​(String sourceId, long timeId, String nodeId)
      Description copied from interface: ElementSink
      A node was removed from the graph.
      Specified by:
      nodeRemoved in interface ElementSink
      Parameters:
      sourceId - Identifier of the graph where the node will be removed.
      nodeId - Identifier of the removed node.

    • stepBegins

      public void stepBegins​(String sourceId, long timeId, double step)
      Description copied from interface: ElementSink

      Since dynamic graphs are based on discrete event modifications, the notion of step is defined to simulate elapsed time between events. So a step is a event that occurs in the graph, it does not modify it but it gives a kind of timestamp that allow the tracking of the progress of the graph over the time.

      This kind of event is useful for dynamic algorithms that listen to the dynamic graph and need to measure the time in the graph's evolution.

      Specified by:
      stepBegins in interface ElementSink
      Parameters:
      sourceId - Identifier of the graph where the step starts.
      timeId - A numerical value that may give a timestamp to track the evolution of the graph over the time.