Package mgui.interfaces.graphs

Class AbstractGraphEdge

java.lang.Object

mgui.interfaces.AbstractInterfaceObject

mgui.interfaces.graphs.AbstractGraphEdge

All Implemented Interfaces:

InterfaceObject, NamedObject, TreeObject, CleanableObject, XMLObject

Direct Known Subclasses:

AbstractNetworkGraphConnection, DefaultGraphEdge

public abstract class AbstractGraphEdge
extends AbstractInterfaceObject
implements XMLObject

Abstract representation of a graph edge, connecting two nodes.

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Nested Class Summary

Nested classes/interfaces inherited from interface mgui.interfaces.xml.XMLObject

XMLObject.XMLEncoding, XMLObject.XMLType

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractGraphNode	from
protected AbstractGraphNode	to
protected edu.uci.ics.jung.graph.util.EdgeType	type

Fields inherited from class mgui.interfaces.AbstractInterfaceObject

isDestroyed, tree_nodes

Constructor Summary

Constructors

Constructor	Description
AbstractGraphEdge(AbstractGraphNode from, AbstractGraphNode to)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()
java.lang.String	getDTD()	Returns the Data Type Declaration (DTD) for this object's XML representation
AbstractGraphNode	getFrom()
java.lang.String	getLabel()
java.lang.String	getLocalName()	Returns the local name associated with this XML object.
java.lang.String	getShortXML(int tab)	Returns a short XML representation of this object.
AbstractGraphNode	getTo()
edu.uci.ics.jung.graph.util.EdgeType	getType()
java.lang.String	getXML()	Returns this object's XML representation as a single string.
java.lang.String	getXML(int tab)	Returns this object's XML representation as a single string.
java.lang.String	getXML(int tab, int v_from, int v_to)	Returns an XML representation for this edge given from and to indices.
java.lang.String	getXMLSchema()	Returns the XML schema for this object's XML representation
void	handleXMLElementEnd(java.lang.String localName)	Handles the end of an XML element.
void	handleXMLElementStart(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type)	Handles the start of an XML element.
void	handleXMLString(java.lang.String s)	Handles a string within an XML element.
void	setFromEdge(AbstractGraphEdge edge)
void	setFromNodes(AbstractGraphNode from, AbstractGraphNode to)
void	setLabel(java.lang.String label)
void	setType(edu.uci.ics.jung.graph.util.EdgeType type)
void	setVertices(AbstractGraphNode from, AbstractGraphNode to)
void	writeXML(int tab, java.io.Writer writer)	Writes the XML representation of this object to file.
void	writeXML(int tab, java.io.Writer writer, ProgressUpdater progress_bar)	Writes the XML representation of this object to file, as XMLType.Normal.
void	writeXML(int tab, java.io.Writer writer, XMLOutputOptions options, ProgressUpdater progress_bar)	Writes the XML representation of this object to file.

Methods inherited from class mgui.interfaces.AbstractInterfaceObject

clean, destroy, getName, getTreeLabel, isDestroyed, issueTreeNode, setName, setTreeNode, updateTreeNodes

Methods inherited from class java.lang.Object

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

Field Details

from

protected AbstractGraphNode from

to

protected AbstractGraphNode to

type

protected edu.uci.ics.jung.graph.util.EdgeType type

Constructor Details

AbstractGraphEdge

public AbstractGraphEdge(AbstractGraphNode from,
AbstractGraphNode to)

Method Details

setFromEdge

public void setFromEdge(AbstractGraphEdge edge)

setFromNodes

public void setFromNodes(AbstractGraphNode from,
AbstractGraphNode to)

getType

public edu.uci.ics.jung.graph.util.EdgeType getType()

setType

public void setType(edu.uci.ics.jung.graph.util.EdgeType type)

getFrom

public AbstractGraphNode getFrom()

getTo

public AbstractGraphNode getTo()

setVertices

public void setVertices(AbstractGraphNode from,
AbstractGraphNode to)

setLabel

public void setLabel(java.lang.String label)

getLabel

public java.lang.String getLabel()

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getDTD

public java.lang.String getDTD()

Description copied from interface: XMLObject

Returns the Data Type Declaration (DTD) for this object's XML representation

See http://en.wikipedia.org/wiki/Document_Type_Definition for a description.

Specified by:

getDTD in interface XMLObject

Returns:

getXMLSchema

public java.lang.String getXMLSchema()

Description copied from interface: XMLObject

Returns the XML schema for this object's XML representation

See http://en.wikipedia.org/wiki/XML_schema.

Specified by:

getXMLSchema in interface XMLObject

Returns:

getXML

public java.lang.String getXML()

Description copied from interface: XMLObject

Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.

Specified by:

getXML in interface XMLObject

Returns:

getXML

public java.lang.String getXML(int tab)

Description copied from interface: XMLObject

Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.

Specified by:

getXML in interface XMLObject

Parameters:

tab - The number of tabs to place before the opening XML wrapper

Returns:

getXML

public java.lang.String getXML(int tab,
int v_from,
int v_to)

Returns an XML representation for this edge given from and to indices.

Parameters:

tab -

v_from -

v_to -

Returns:

getLocalName

public java.lang.String getLocalName()

Description copied from interface: XMLObject

Returns the local name associated with this XML object.

Specified by:

getLocalName in interface XMLObject

Returns:

handleXMLElementStart

public void handleXMLElementStart(java.lang.String localName,
org.xml.sax.Attributes attributes,
XMLObject.XMLType type)
                           throws org.xml.sax.SAXException

Description copied from interface: XMLObject

Handles the start of an XML element.

Specified by:

handleXMLElementStart in interface XMLObject

Parameters:

localName - Local name of the element

attributes - Set of element attributes

type - The XMLType of this element

Throws:

org.xml.sax.SAXException

handleXMLElementEnd

public void handleXMLElementEnd(java.lang.String localName)
                         throws org.xml.sax.SAXException

Description copied from interface: XMLObject

Handles the end of an XML element.

Specified by:

handleXMLElementEnd in interface XMLObject

Parameters:

localName - Local name of the element

Throws:

org.xml.sax.SAXException

handleXMLString

public void handleXMLString(java.lang.String s)
                     throws org.xml.sax.SAXException

Description copied from interface: XMLObject

Handles a string within an XML element.

Specified by:

handleXMLString in interface XMLObject

Parameters:

s - String to handle

Throws:

org.xml.sax.SAXException

writeXML

public void writeXML(int tab,
java.io.Writer writer,
XMLOutputOptions options,
ProgressUpdater progress_bar)
              throws java.io.IOException

Description copied from interface: XMLObject

Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.

Specified by:

writeXML in interface XMLObject

Parameters:

tab - The number of tabs to place before the XML text

writer - The writer

options - XMLOutputOptions defining the write parameters

progress_bar - Optional progress updater (may be null)

Throws:

java.io.IOException

writeXML

public void writeXML(int tab,
java.io.Writer writer,
ProgressUpdater progress_bar)
              throws java.io.IOException

Description copied from interface: XMLObject

Writes the XML representation of this object to file, as XMLType.Normal. The default format of XMLFormat.Ascii will be used. The basic contract for this method is that it should not write a newline character at its start or end.

Specified by:

writeXML in interface XMLObject

Parameters:

tab - The number of tabs to place before the XML text

writer - The writer

progress_bar - Optional progress updater (may be null)

Throws:

java.io.IOException

writeXML

public void writeXML(int tab,
java.io.Writer writer)
              throws java.io.IOException

Description copied from interface: XMLObject

Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.

Specified by:

writeXML in interface XMLObject

Parameters:

tab - The number of tabs to place before the XML text

writer - The writer

Throws:

java.io.IOException

getShortXML

public java.lang.String getShortXML(int tab)

Description copied from interface: XMLObject

Returns a short XML representation of this object.

Specified by:

getShortXML in interface XMLObject

Returns: