charger.cgx

Class CGXParser

Object

org.xml.sax.helpers.DefaultHandler

charger.cgx.CGXParser

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class CGXParser
extends org.xml.sax.helpers.DefaultHandler

Used for parsing XML representations of a conceptual graph into its CharGer internal form. Uses the DOM parsing routines.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_ignoreLayout
private boolean	_keepIDs
private boolean	_makeList Whether to gather all parsed objects into a arraylist (usually used for selecting)
private Point2D.Double	_offset
private ArrayList	_parsedObjects
private boolean	_preserveGraph Whether to keep the top level graph intact (perhaps adding to it), but retaining its created, modified, etc.
private Graph	_topLevelGraph
private boolean	_traceTags
static Properties	CharGerXMLTagNameToClassName used to keep track of old and new versions of CharGer class names that might appear in a ".cgx" file.
(package private) String	definition
(package private) ArrayList	descriptors
(package private) org.w3c.dom.Document	doc
(package private) GenericTypeDescriptor	genericDescr
(package private) String	genericString
static Point2D.Double	offsetZero
private Hashtable<String,String>	oldNewIDs Has entries of the form "nnn", "nnn" denoting the old ident (i.e.
(package private) StringBuilder	stringCollector
(package private) WordnetTypeDescriptor	wordnetDescr

Constructor Summary

Constructors

Constructor and Description
CGXParser() Parser works as an instance; this allows for multiple parsers to be open at the same time.
CGXParser(InputStream is)
CGXParser(String input) Used for copy/paste.

Method Summary

Modifier and Type	Method and Description
void	buildDocument(InputStream is) Create the entire parse tree for the document.
Point2D.Double	getOffset()
Graph	getParsedGraph()
ArrayList<GraphObject>	getParsedObjects()
private GraphObject	instantiateGraphObject(String tagname) Factory to create a graph object from the given tagname.
boolean	isIgnoreLayout()
boolean	isKeepIDs()
boolean	isMakeList()
boolean	isPreserveGraph()
static void	loadCharGerKeyWordToClassTable() Creates a lookup that helps parsers determine (from an XML tag) what class is required.
void	parseCGXMLCG(Graph graph) Assumes that the Document has already been built.
void	parseCGXMLGraphTagElement(org.w3c.dom.Element graphelem, Graph g) Handle the "graph" tag.
void	parseColorInfo(org.w3c.dom.Node node, GraphObject go) Assumes its node is a "color" tag generated by Charger.
void	parseEdgeInfo(org.w3c.dom.Node node, GraphObject go) Handles the "edge" tag element for arrow height, width and edge thickness.
void	parseFontInfo(org.w3c.dom.Node node, GraphObject go) Handles the "font" tag element for arrow height, width and edge thickness.
static ArrayList<GraphObject>	parseForCopying(String cgxmlString, Graph g) Factory method for setting up a parser for a list of graph objects from a string.
static boolean	parseForNewGraph(InputStream is, Graph g) Factory method for setting up a parser for a new graph from a stream.
static void	parseForNewGraph(String xmlString, Graph g) Factory method for setting up a parser for a new graph from a string.
void	parseGraphObjectElement(org.w3c.dom.Element goelem, GraphObject go) Handles any document element representing a GraphObject.
void	parseHistoryInfo(org.w3c.dom.Element historyElem, GraphObject go) Handles the "history" tag element which contains one or more history event nodes..
void	parseHistoryRecordInfo(org.w3c.dom.Element eventElem, GraphObject go) Parse an individual history event tag and add the history event to the given object.
void	parseLayoutInfo(org.w3c.dom.Element layoutElem, GraphObject go) Handles the "layout" tag element for the rectangle, color, font and edge elements.
void	parseLayoutOnly(GraphObject go) Assume document consists of only layout information.
void	parseRectangleInfo(org.w3c.dom.Node node, GraphObject go) Assumes its node is a rectangle tag from Charger.
void	parseRectangleInfo(org.w3c.dom.Node node, GraphObject go, Point2D.Double offset) Handles the "rectangle" tag element for arrow height, width and edge thickness.
void	parseReferentInfo(org.w3c.dom.Element element, GraphObject go) Handles the "referent" tag element
static Color	parseRGB(String rgb)
void	parseTypeInfo(org.w3c.dom.Element element, GraphObject go) Handles the "type" tag element for the type label and for both generic descriptors and wordnet descriptors.
void	setID(org.w3c.dom.Element elem, GraphObject go) Set the object's id, either by using its already-generated id or else by the id attribute in the element.
void	setIgnoreLayout(boolean _ignoreLayout)
void	setKeepIDs(boolean _keepIDs)
void	setMakeList(boolean _makeList)
void	setOffset(Point2D.Double _offset)
void	setParsedObjects(ArrayList<GraphObject> _parsedObjects)
void	setPreserveGraph(boolean _preserveGraph)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class Object

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

Field Detail

doc

org.w3c.dom.Document doc

_traceTags

private boolean _traceTags

_keepIDs

private boolean _keepIDs

_ignoreLayout

private boolean _ignoreLayout

_preserveGraph

private boolean _preserveGraph

Whether to keep the top level graph intact (perhaps adding to it), but retaining its created, modified, etc.

_makeList

private boolean _makeList

Whether to gather all parsed objects into a arraylist (usually used for selecting)

offsetZero

public static Point2D.Double offsetZero

_offset

private Point2D.Double _offset

_parsedObjects

private ArrayList _parsedObjects

_topLevelGraph

private Graph _topLevelGraph

oldNewIDs

private Hashtable<String,String> oldNewIDs

Has entries of the form "nnn", "nnn" denoting the old ident (i.e. the one in the file) and the new ident which has been assigned during this parse. Assures that no two "new" objects have the same ident.

genericString

String genericString

stringCollector

StringBuilder stringCollector

wordnetDescr

WordnetTypeDescriptor wordnetDescr

genericDescr

GenericTypeDescriptor genericDescr

descriptors

ArrayList descriptors

definition

String definition

CharGerXMLTagNameToClassName

public static Properties CharGerXMLTagNameToClassName

used to keep track of old and new versions of CharGer class names that might appear in a ".cgx" file.

Constructor Detail

CGXParser

public CGXParser()

Parser works as an instance; this allows for multiple parsers to be open at the same time.

CGXParser

public CGXParser(String input)
          throws CGEncodingException

Used for copy/paste. Encoding exceptions should never occur since internal strings are all UTF-8.

Parameters:

input -

Throws:

CGEncodingException

CGXParser

public CGXParser(InputStream is)
          throws CGEncodingException

Throws:

CGEncodingException

Method Detail

isIgnoreLayout

public boolean isIgnoreLayout()

setIgnoreLayout

public void setIgnoreLayout(boolean _ignoreLayout)

isKeepIDs

public boolean isKeepIDs()

setKeepIDs

public void setKeepIDs(boolean _keepIDs)

getOffset

public Point2D.Double getOffset()

setOffset

public void setOffset(Point2D.Double _offset)

isMakeList

public boolean isMakeList()

setMakeList

public void setMakeList(boolean _makeList)

isPreserveGraph

public boolean isPreserveGraph()

setPreserveGraph

public void setPreserveGraph(boolean _preserveGraph)

getParsedObjects

public ArrayList<GraphObject> getParsedObjects()

setParsedObjects

public void setParsedObjects(ArrayList<GraphObject> _parsedObjects)

getParsedGraph

public Graph getParsedGraph()

loadCharGerKeyWordToClassTable

public static void loadCharGerKeyWordToClassTable()

Creates a lookup that helps parsers determine (from an XML tag) what class is required. This could probably be replaced with a simple Encode/Decode XML "XML serialized" version.

parseForNewGraph

public static boolean parseForNewGraph(InputStream is,
                                       Graph g)

Factory method for setting up a parser for a new graph from a stream.

Parameters:

is -

Returns:

true if parser instance was instantiated and all worked properly; false otherwise.

parseForNewGraph

public static void parseForNewGraph(String xmlString,
                                    Graph g)

Factory method for setting up a parser for a new graph from a string. May be used either for reading in an entirely new graph or for restoring one (e.g., via undo).

Parameters:

xmlString - a complete cgx graph string

parseForCopying

public static ArrayList<GraphObject> parseForCopying(String cgxmlString,
                                                     Graph g)

Factory method for setting up a parser for a list of graph objects from a string. To get the list of objects, caller needs to follow up with a call to getParsedObjects

Parameters:

cgxmlString - a string of an arbitrary set of objects

g - the graph to which the parsed objects will be added

Returns:

parser instance appropriately set up.

buildDocument

public void buildDocument(InputStream is)
                   throws CGEncodingException

Create the entire parse tree for the document.

Parameters:

is - an XML stream containing CG-XML objects.

Throws:

CGEncodingException

parseCGXMLCG

public void parseCGXMLCG(Graph graph)

Assumes that the Document has already been built. This is the very top of the parse tree processing.

Parameters:

graph - initialized but possibly empty graph

parseCGXMLGraphTagElement

public void parseCGXMLGraphTagElement(org.w3c.dom.Element graphelem,
                                      Graph g)

Handle the "graph" tag. Assumes that the element is a "graph" tag and that the graph object itself is either the top level graph or it's been added to the graph it belongs to.

Parameters:

graphelem -

g - the graph object, already instantiated (but probably empty).

parseLayoutOnly

public void parseLayoutOnly(GraphObject go)

Assume document consists of only layout information. This is primarily used by the CGIF parser for CG comments.

parseTypeInfo

public void parseTypeInfo(org.w3c.dom.Element element,
                          GraphObject go)

Handles the "type" tag element for the type label and for both generic descriptors and wordnet descriptors.

Parameters:

node - The DOM element containing the tag and its subtree.

go - the graph object to be modified

See Also:

WordnetTypeDescriptor.getInstanceFromXMLDOM(org.w3c.dom.Element), GenericTypeDescriptor.getInstanceFromXMLDOM(org.w3c.dom.Element)

parseReferentInfo

public void parseReferentInfo(org.w3c.dom.Element element,
                              GraphObject go)

Handles the "referent" tag element

Parameters:

element - The DOM element containing the tag and its subtree.

go - the graph object to be modified

parseLayoutInfo

public void parseLayoutInfo(org.w3c.dom.Element layoutElem,
                            GraphObject go)

Handles the "layout" tag element for the rectangle, color, font and edge elements.

Parameters:

layoutElem - The DOM element containing the tag and its subtree.

go - the graph object to be modified

parseRectangleInfo

public void parseRectangleInfo(org.w3c.dom.Node node,
                               GraphObject go)

Assumes its node is a rectangle tag from Charger. Updates the graph object according to the display rect implied by the rectangle. Uses the pre-set offset for the entire parser.

Parameters:

node -

go -

See Also:

parseRectangleInfo(org.w3c.dom.Node, charger.obj.GraphObject, java.awt.geom.Point2D.Double)

parseRectangleInfo

public void parseRectangleInfo(org.w3c.dom.Node node,
                               GraphObject go,
                               Point2D.Double offset)

Handles the "rectangle" tag element for arrow height, width and edge thickness.

Parameters:

node - The DOM element containing the tag and its subtree.

go - the graph object to be modified

parseColorInfo

public void parseColorInfo(org.w3c.dom.Node node,
                           GraphObject go)

Assumes its node is a "color" tag generated by Charger. Updates the graph object according to the color info parsed.

Parameters:

node - The DOM element containing the tag and its subtree.

go - the graph object to be modified

parseFontInfo

public void parseFontInfo(org.w3c.dom.Node node,
                          GraphObject go)

Handles the "font" tag element for arrow height, width and edge thickness.

Parameters:

node - The DOM element containing the tag and its subtree.

go - the graph object to be modified

parseEdgeInfo

public void parseEdgeInfo(org.w3c.dom.Node node,
                          GraphObject go)

Handles the "edge" tag element for arrow height, width and edge thickness.

Parameters:

node - The DOM element containing the tag and its subtree.

go - the edge to be modified

parseRGB

public static Color parseRGB(String rgb)

Parameters:

rgb - a string of the form "rrr,ggg,bbb"

Returns:

the corresponding color, or black if null argument.

parseHistoryInfo

public void parseHistoryInfo(org.w3c.dom.Element historyElem,
                             GraphObject go)

Handles the "history" tag element which contains one or more history event nodes..

Parameters:

historyElem - The DOM element containing the tag and its subtree.

go - the graph object to which the history belongs

parseHistoryRecordInfo

public void parseHistoryRecordInfo(org.w3c.dom.Element eventElem,
                                   GraphObject go)

Parse an individual history event tag and add the history event to the given object. Parses all history events that CharGer knows about. If the type is not recognized, then ignore it. TODO: figure out how to instantiate ones it doesn't know...

Parameters:

eventElem - a DOM node with an "event" tag.

go -

instantiateGraphObject

private GraphObject instantiateGraphObject(String tagname)

Factory to create a graph object from the given tagname. The tagname is the not the actual name of the class, but can be looked up in the tagname to classname map. Instantiates the object, but doesn't fill in any information.

Returns:

an instantiated GraphObject of type indicated by the tagname; null if the name isn't recognized,

See Also:

CharGerXMLTagNameToClassName

setID

public void setID(org.w3c.dom.Element elem,
                  GraphObject go)

Set the object's id, either by using its already-generated id or else by the id attribute in the element. If not keeping old id's then put the new id in the old-new id hashtable.

Parameters:

elem - Any element that might contain an "id" attribute

go - The object whose id is to be set.

parseGraphObjectElement

public void parseGraphObjectElement(org.w3c.dom.Element goelem,
                                    GraphObject go)

Handles any document element representing a GraphObject.

Parameters:

goelem - The graphobject tag element. Uses the tag name to determine which type argument "go" is.

go - The graph object whose properties are to be set from this. Must be already instantiated. element.