de.saxsys.svgfx.xml.core

Class SAXParser<TResult,TDataProvider extends IDataProvider,TElementCreator extends IElementCreator<TDataProvider,TElement>,TElement extends ElementBase<TDataProvider,?,TElement>>

java.lang.Object

org.xml.sax.helpers.DefaultHandler

de.saxsys.svgfx.xml.core.SAXParser<TResult,TDataProvider,TElementCreator,TElement>

Type Parameters:

TResult - the type of the result provided by this parser

TDataProvider - the type of the IDataProvider

TElementCreator - the type of the IElementCreator @author Xyanid on 24.10.2015.

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

SVGParser

public abstract class SAXParser<TResult,TDataProvider extends IDataProvider,TElementCreator extends IElementCreator<TDataProvider,TElement>,TElement extends ElementBase<TDataProvider,?,TElement>>
extends org.xml.sax.helpers.DefaultHandler

Basic XML parser which uses a given elementCreator to process the data provided while parsing.

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyProperty<SAXParser.State>	state Gets the property State.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SAXParser.State Determines in which state the converter is in.

Constructor Summary

Constructors

Constructor and Description
SAXParser(TElementCreator elementCreator, TDataProvider dataProvider) Creates a new instance of the parser using the provided interfaces.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	clear() This method will clear the current result as well as calling IDataProvider.clear().
protected abstract void	consumeElementEnd(TResult result, TDataProvider dataProvider, TElement element) This method will be called when an element has ended in the XML tree.
protected abstract void	consumeElementStart(TResult result, TDataProvider dataProvider, TElement element) This method will be called when a new element is starting in the XML tree.
void	endDocument()
void	endElement(String namespaceURI, String localName, String qName)
protected abstract TResult	enteringDocument() This method will be called as soon as the parsing of the document has started and set the current result.
long	getAttemptedParses() gets the attemptedParses.
TResult	getResult() Gets the result, which is only set after parse(InputSource) has been called.
SAXParser.State	getState() Gets the value of the State.
long	getSuccessfulParses() gets the successfulParses.
boolean	isBusy() Determines if the parser is busy doing its work, this is the case if the state is not IDLE or FINISHED.
protected abstract void	leavingDocument(TResult result) This method will be called as soon as the parsing of the document has been finished, the current result will be be provided so final operation can be performed.
void	parse(File file) Parses the data of the given file.
void	parse(InputSource data) Parse the data of the given input source.
void	parse(String path) Parses the data of the file provided by the given path.
void	setSuccessfulParses(long value) sets the successfulParses.
void	startDocument()
void	startElement(String namespaceURI, String localName, String qName, Attributes attributes)
javafx.beans.property.ReadOnlyProperty<SAXParser.State>	stateProperty() Gets the property State.

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

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

Methods inherited from class java.lang.Object

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

Property Detail

state

public final javafx.beans.property.ReadOnlyProperty<SAXParser.State> stateProperty

Gets the property State.

Returns:

the State property

Constructor Detail

SAXParser

public SAXParser(TElementCreator elementCreator,
                 TDataProvider dataProvider)
          throws IllegalArgumentException

Creates a new instance of the parser using the provided interfaces.

Parameters:

elementCreator - element creator to be used

dataProvider - data provider to be used

Throws:

IllegalArgumentException - if either elementCreator or dataProvider are null

Method Detail

getResult

public final TResult getResult()

Gets the result, which is only set after parse(InputSource) has been called.

Returns:

result

getAttemptedParses

public final long getAttemptedParses()

gets the attemptedParses.

Returns:

the attemptedParses

getSuccessfulParses

public final long getSuccessfulParses()

gets the successfulParses.

Returns:

the successfulParses

setSuccessfulParses

public final void setSuccessfulParses(long value)

sets the successfulParses.

Parameters:

value - value to be used for successfulParses

getState

public final SAXParser.State getState()

Gets the value of the State.

Returns:

the value of the State

isBusy

public final boolean isBusy()

Determines if the parser is busy doing its work, this is the case if the state is not IDLE or FINISHED.

Returns:

true if the parser is busy, otherwise false.

enteringDocument

protected abstract TResult enteringDocument()
                                     throws SAXException

This method will be called as soon as the parsing of the document has started and set the current result. Ideally a new result will be initialized here so it can be filled when the document is processed.

Returns:

the new value for the result.

Throws:

SAXException - when an error occurs

leavingDocument

protected abstract void leavingDocument(TResult result)
                                 throws SAXException

This method will be called as soon as the parsing of the document has been finished, the current result will be be provided so final operation can be performed.

Parameters:

result - the current result, which was initialized during enteringDocument().

Throws:

SAXException - when an error occurs

consumeElementStart

protected abstract void consumeElementStart(TResult result,
                                            TDataProvider dataProvider,
                                            TElement element)
                                     throws SAXException

This method will be called when a new element is starting in the XML tree. If possible the data of the element can be processed here already for the result.

Parameters:

result - the current result, which was initialized during enteringDocument().

dataProvider - the dataProvider that as provided during initialization

element - element to be consumed

Throws:

SAXException - when an error occurs

consumeElementEnd

protected abstract void consumeElementEnd(TResult result,
                                          TDataProvider dataProvider,
                                          TElement element)
                                   throws SAXException

This method will be called when an element has ended in the XML tree. Generally the data of the element should be consumed here, however it might not be necessary to consume the data of the element here, since it could be contained in another element. E.g. if an element A contains an element B, then the data of B can still be consumed when element A ends, since element B will be available as child of A.

Parameters:

result - the current result, which was initialized during enteringDocument().

dataProvider - the dataProvider that as provided during initialization.

element - element to be consumed.

Throws:

SAXException - when an error occurs

stateProperty

public final javafx.beans.property.ReadOnlyProperty<SAXParser.State> stateProperty()

Gets the property State.

Returns:

the State property

clear

public final void clear()

This method will clear the current result as well as calling IDataProvider.clear().

parse

public final void parse(String path)
                 throws SAXParseException,
                        IllegalArgumentException,
                        IllegalStateException,
                        IOException

Parses the data of the file provided by the given path.

Parameters:

path - path of the file to be used

Throws:

SAXParseException - if an exception occurs while parsing the data

IllegalArgumentException - if the given file is null

IllegalStateException - if this method is being called while the parser is still busy

IOException - if the file can not be found or opened

parse

public final void parse(File file)
                 throws SAXParseException,
                        IllegalArgumentException,
                        IllegalStateException,
                        IOException

Parses the data of the given file.

Parameters:

file - file to be used

Throws:

SAXParseException - if an exception occurs while parsing the data

IllegalArgumentException - if the given file is null

IllegalStateException - if this method is being called while the parser is still busy

IOException - if the file can not be found or opened

parse

public final void parse(InputSource data)
                 throws SAXParseException,
                        IllegalArgumentException,
                        IllegalStateException

Parse the data of the given input source.

Parameters:

data - data to be used, must not be null

Throws:

SAXParseException - if an exception occurs while parsing the data

IllegalArgumentException - if the given data is null

IllegalStateException - if this method is being called while the parser is still busy

startDocument

public final void startDocument()
                         throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endDocument

public final void endDocument()
                       throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startElement

public final void startElement(String namespaceURI,
                               String localName,
                               String qName,
                               Attributes attributes)
                        throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

endElement

public final void endElement(String namespaceURI,
                             String localName,
                             String qName)
                      throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

characters

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

Specified by:

characters in interface ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException