org.apache.flex.compiler.internal.fxg.sax

Class FXGSAXScanner

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.flex.compiler.internal.fxg.sax.FXGSAXScanner

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class FXGSAXScanner
extends DefaultHandler

This SAX2 based scanner converts an FXG document (an XML based description of a graphical asset) to a simple object graph to serve as an intermediate representation. The document must be in the FXG 1.0 namespace and the root element must be a <Graphic> tag.

Constructor Summary

Constructors

Constructor and Description
FXGSAXScanner(Collection<ICompilerProblem> problems) Construct a new FXGSAXScanner

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
protected IFXGNode	createNode(String uri, String localName) Attempts to construct an instance of IFXGNode for the given element.
void	endElement(String uri, String localName, String name)
String	getDocumentPath() Get document path used for logging.
IFXGNode	getRootNode() Provides access to the root IFXGNode of the FXG document AFTER parsing.
int	getStartColumn()
int	getStartLine()
protected boolean	isFXGNamespace(String uri)
protected boolean	isSkippedElement(String uri, String localName, boolean startElement) Determines whether an element should be skipped.
void	setDocumentLocator(Locator locator)
void	setDocumentPath(String documentPath) Set document path used for logging.
void	startDocument()
void	startElement(String uri, String localName, String name, Attributes attributes)

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

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

FXGSAXScanner

public FXGSAXScanner(Collection<ICompilerProblem> problems)

Construct a new FXGSAXScanner

Method Detail

getRootNode

public IFXGNode getRootNode()

Provides access to the root IFXGNode of the FXG document AFTER parsing.

Returns:

the root IFXGNode of the DOM.

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

getDocumentPath

public String getDocumentPath()

Get document path used for logging.

setDocumentPath

public void setDocumentPath(String documentPath)

Set document path used for logging.

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

startElement

public void startElement(String uri,
                String localName,
                String name,
                Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

characters

public void characters(char[] ch,
              int start,
              int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
              String localName,
              String name)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

getStartLine

public int getStartLine()

Returns:

the last processed line number

getStartColumn

public int getStartColumn()

Returns:

the last processed column number

isFXGNamespace

protected boolean isFXGNamespace(String uri)

Parameters:

uri - - the namespace URI to check

Returns:

whether the given namespace URI is considered an FXG namespace.

isSkippedElement

protected boolean isSkippedElement(String uri,
                       String localName,
                       boolean startElement)

Determines whether an element should be skipped.

Parameters:

uri - - the namespace URI of the element

localName - - the name of the element

Returns:

true if the element has been marked as skipped, otherwise false.

createNode

protected IFXGNode createNode(String uri,
                  String localName)

Attempts to construct an instance of IFXGNode for the given element.

Parameters:

uri - - the namespace URI of the element

localName - - the name of the element

Returns:

IFXGNode instance if