org.graphstream.stream
Interface Source

All Known Subinterfaces:
FileSource, Graph, Layout, Pipe, ProxyPipe, URLSource
All Known Implementing Classes:
AbstractGraph, AdjacencyListGraph, AttributePipe, DefaultGraph, FileSourceBase, FileSourceDGS, FileSourceDGS1And2, FileSourceDOT, FileSourceEdge, FileSourceGEXF, FileSourceGML, FileSourceGraphML, FileSourceLGL, FileSourceNCol, FileSourcePajek, FileSourceParser, FileSourceTLP, FileSourceXML, GraphicGraph, GraphReplay, HTTPSource, MultiGraph, OldFileSourceDGS, PipeAdapter, PipeBase, RMISource, SingleGraph, SourceAdapter, SourceBase, SpringBox, ThreadProxyPipe, ViewerPipe

public interface Source

Source of graph events.

An source is something that produces graph events (attributes and elements), but does not contain a graph instance.

See Also:
Sink, Pipe

Method Summary
 void addAttributeSink(AttributeSink sink)
          Add a sink for attribute events only.
 void addElementSink(ElementSink sink)
          Add a sink for elements events only.
 void addSink(Sink sink)
          Add a sink for all graph events (attributes and graph elements) coming from this source.
 void clearAttributeSinks()
          Remove all listener attribute sinks.
 void clearElementSinks()
          Remove all listener element sinks.
 void clearSinks()
          Remove all listener sinks.
 void removeAttributeSink(AttributeSink sink)
          Remove an attribute sink.
 void removeElementSink(ElementSink sink)
          Remove an element sink.
 void removeSink(Sink sink)
          Remove a sink.
 

Method Detail

addSink

void addSink(Sink sink)
Add a sink for all graph events (attributes and graph elements) coming from this source. This is similar to registering a sink for attributes an another for elements.

Parameters:
sink - The sink to register.

removeSink

void removeSink(Sink sink)
Remove a sink.

Parameters:
sink - The sink to remove, if it does not exist, this is ignored silently.

addAttributeSink

void addAttributeSink(AttributeSink sink)
Add a sink for attribute events only. Attribute events include attribute addition change and removal.

Parameters:
sink - The sink to register.

removeAttributeSink

void removeAttributeSink(AttributeSink sink)
Remove an attribute sink.

Parameters:
sink - The sink to remove, if it does not exist, this is ignored silently.

addElementSink

void addElementSink(ElementSink sink)
Add a sink for elements events only. Elements events include, addition and removal of nodes and edges, as well as step events.

Parameters:
sink - The sink to register.

removeElementSink

void removeElementSink(ElementSink sink)
Remove an element sink.

Parameters:
sink - The sink to remove, if it does not exist, this is ignored silently.

clearElementSinks

void clearElementSinks()
Remove all listener element sinks.


clearAttributeSinks

void clearAttributeSinks()
Remove all listener attribute sinks.


clearSinks

void clearSinks()
Remove all listener sinks.



Copyright © 2011. All Rights Reserved.