y.io.gml
Class HierarchicGraphObjectEncoder

java.lang.Object
  y.io.gml.HierarchicGraphObjectEncoder

All Implemented Interfaces:

ObjectEncoder

public class HierarchicGraphObjectEncoder
extends java.lang.Object
implements ObjectEncoder

This class is capable of encoding a Hierarchic Graph in valid gml format. It is used by HierarchicGraphEncoderFactory.

Constructor Summary

HierarchicGraphObjectEncoder(HierarchicGraphObjectEncoder parent)

HierarchicGraphObjectEncoder(ObjectEncoder graphEncoder, ObjectEncoder interEdgeEncoder, HierarchicGraphObjectEncoder parent)

Method Summary

java.lang.String	createNodeReference(Graph forGraph, Node n, HierarchyManager hm) Creates the reference string for a node in the given graph given a hierarchy manager.
void	encode(java.lang.Object item, GMLEncoder enc) This method will try to encode the given object using the GMLEncoder
ObjectEncoder	getGraphEncoder() Getter for property graphEncoder.
ObjectEncoder	getInterEdgeEncoder() Getter for property interEdgeEncoder.
java.util.List	getInterEdgeList() Retrieves the list that contains all inter edges that have been parsed.
void	setGraphEncoder(ObjectEncoder graphEncoder) Setter for property graphEncoder.
void	setInterEdgeEncoder(ObjectEncoder interEdgeEncoder) Setter for property interEdgeEncoder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HierarchicGraphObjectEncoder

public HierarchicGraphObjectEncoder(HierarchicGraphObjectEncoder parent)

HierarchicGraphObjectEncoder

public HierarchicGraphObjectEncoder(ObjectEncoder graphEncoder,
                                    ObjectEncoder interEdgeEncoder,
                                    HierarchicGraphObjectEncoder parent)

Method Detail

encode

public void encode(java.lang.Object item,
                   GMLEncoder enc)
            throws java.io.IOException

Description copied from interface: ObjectEncoder

This method will try to encode the given object using the GMLEncoder

Specified by:

encode in interface ObjectEncoder

Parameters:

item - the object to be encoded

enc - an encoder

Throws:

java.io.IOException - in the case of an I/O exception

getInterEdgeEncoder

public ObjectEncoder getInterEdgeEncoder()

Getter for property interEdgeEncoder.

Returns:

Value of property interEdgeEncoder.

setInterEdgeEncoder

public void setInterEdgeEncoder(ObjectEncoder interEdgeEncoder)

Setter for property interEdgeEncoder.

Parameters:

interEdgeEncoder - New value of property interEdgeEncoder.

getInterEdgeList

public java.util.List getInterEdgeList()

Retrieves the list that contains all inter edges that have been parsed. This list contains items of type InterEdge.

createNodeReference

public java.lang.String createNodeReference(Graph forGraph,
                                            Node n,
                                            HierarchyManager hm)

Creates the reference string for a node in the given graph given a hierarchy manager. This string will be used to uniquely specify the end points of inter edges in a hierarchically grouped graph.

getGraphEncoder

public ObjectEncoder getGraphEncoder()

Getter for property graphEncoder.

Returns:

Value of property graphEncoder.

setGraphEncoder

public void setGraphEncoder(ObjectEncoder graphEncoder)

Setter for property graphEncoder.

Parameters:

graphEncoder - New value of property graphEncoder.