|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.uci.ics.jung.io.graphml.GraphMLReader2<G,V,E>
G - The graph type to be read from the GraphML fileV - The vertex type used by the graphE - The edge type used by the graphpublic class GraphMLReader2<G extends Hypergraph<V,E>,V,E>
Reads in data from a GraphML-formatted file and generates graphs based on that data. Does not currently support nested graphs.
Note that the user is responsible for supplying a graphTransformer that will create graphs capable of supporting the
edge types in the supplied GraphML file. If the graph generated by the
Factory is not compatible (for example: if the graph does not
accept directed edges, and the GraphML file contains a directed edge) then
the results are graph-implementation-dependent.
| Field Summary | |
|---|---|
protected GraphMLDocument |
document
|
protected |
edgeTransformer
|
protected Reader |
fileReader
|
protected |
graphTransformer
|
protected |
hyperEdgeTransformer
|
protected boolean |
initialized
|
protected ElementParserRegistry<G,V,E> |
parserRegistry
|
protected |
vertexTransformer
|
protected XMLEventReader |
xmlEventReader
|
| Constructor Summary | |
|---|---|
GraphMLReader2(Reader fileReader,
Constructs a GraphML reader around the given reader. |
|
| Method Summary | |
|---|---|
void |
close()
Closes the GraphML reader and disposes of any resources. |
|
getEdgeTransformer()
Gets the current transformer that is being used for edge objects. |
GraphMLDocument |
getGraphMLDocument()
Returns the object that contains the metadata read in from the GraphML document |
|
getGraphTransformer()
Gets the current transformer that is being used for graph objects. |
|
getHyperEdgeTransformer()
Gets the current transformer that is being used for hyperedge objects. |
|
getVertexTransformer()
Gets the current transformer that is being used for vertex objects. |
void |
init()
Verifies the object state and initializes this reader. |
G |
readGraph()
Reads a single graph object from the GraphML document. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected XMLEventReader xmlEventReader
protected Reader fileReader
protectedgraphTransformer
protectedvertexTransformer
protectededgeTransformer
protectedhyperEdgeTransformer
protected boolean initialized
protected final GraphMLDocument document
protected final ElementParserRegistry<G extends Hypergraph<V,E>,V,E> parserRegistry
| Constructor Detail |
|---|
public GraphMLReader2(Reader fileReader,
graphTransformer,
vertexTransformer,
edgeTransformer,
hyperEdgeTransformer)
fileReader - the reader for the input GraphML document.graphTransformer - Transformation function to convert from GraphML GraphMetadata
to graph objects. This must be non-null.vertexTransformer - Transformation function to convert from GraphML NodeMetadata
to vertex objects. This must be non-null.edgeTransformer - Transformation function to convert from GraphML EdgeMetadata
to edge objects. This must be non-null.hyperEdgeTransformer - Transformation function to convert from GraphML
HyperEdgeMetadata to edge objects. This must be non-null.
IllegalArgumentException - thrown if any of the arguments are null.| Method Detail |
|---|
publicgetGraphTransformer()
publicgetVertexTransformer()
publicgetEdgeTransformer()
publicgetHyperEdgeTransformer()
public void init()
throws GraphIOException
GraphReaderException
will be thrown. This method may be called more than once.
Successive calls will have no effect.
GraphIOException - thrown if an error occurred.
public void close()
throws GraphIOException
close in interface GraphReader<G extends Hypergraph<V,E>,V,E>GraphIOException - thrown if an error occurs.public GraphMLDocument getGraphMLDocument()
public G readGraph()
throws GraphIOException
init to initialize the state of the reader.
readGraph in interface GraphReader<G extends Hypergraph<V,E>,V,E>GraphIOException - thrown if an error occurred.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||