de.saxsys.svgfx.xml.core

Class SAXParser<TResult,TDocumentDataProvider extends IDocumentDataProvider,TElementFactory extends IElementFactory<TDocumentDataProvider,TElement>,TElement extends ElementBase<?,?,TDocumentDataProvider,?,TElement>>

java.lang.Object

org.xml.sax.helpers.DefaultHandler

de.saxsys.svgfx.xml.core.SAXParser<TResult,TDocumentDataProvider,TElementFactory,TElement>

Type Parameters:

TResult - the type of the result provided by this parser

TDocumentDataProvider - the type of the IDocumentDataProvider

TElementFactory - the type of the IElementFactory @author Xyanid on 24.10.2015.

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

SVGParser

public abstract class SAXParser<TResult,TDocumentDataProvider extends IDocumentDataProvider,TElementFactory extends IElementFactory<TDocumentDataProvider,TElement>,TElement extends ElementBase<?,?,TDocumentDataProvider,?,TElement>>
extends org.xml.sax.helpers.DefaultHandler
implements EntityResolver

Basic XML parser which uses a given elementFactory 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(TElementFactory elementFactory, TDocumentDataProvider documentDataProvider) 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 IDocumentDataProvider.clear().
protected abstract void	configureReader(XMLReader reader) Allows to configure the reader that will be used to parse the file.
void	endDocument()
void	endElement(String namespaceURI, String localName, String qName)
protected abstract void	enteringDocument() This method will be called as soon as the parsing of the document has started.
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 TResult	leavingDocument(TElement element) This method will be called as soon as the parsing of the document has been finished.
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.
InputSource	resolveEntity(String publicId, String systemId)
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, 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(TElementFactory elementFactory,
                 TDocumentDataProvider documentDataProvider)
          throws IllegalArgumentException

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

Parameters:

elementFactory - element creator to be used

documentDataProvider - data provider to be used

Throws:

IllegalArgumentException - if either elementFactory or documentDataProvider 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

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.

stateProperty

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

Gets the property State.

Returns:

the State property

configureReader

protected abstract void configureReader(XMLReader reader)
                                 throws SAXException

Allows to configure the reader that will be used to parse the file. NOte. it is not possible to do the following:

• assign a new handler
• assign a new entity resolver
• toggling sax validation

Parameters:

reader - the XMLReader that is being used.

Throws:

SAXException - when an error occurs during the configuration.

enteringDocument

protected abstract void enteringDocument()
                                  throws SAXException

This method will be called as soon as the parsing of the document has started.

Throws:

SAXException - when an error occurs

leavingDocument

protected abstract TResult leavingDocument(TElement element)
                                    throws SAXException

This method will be called as soon as the parsing of the document has been finished.

Parameters:

element - the element that is the first element in the structure of the file.

Returns:

the result, which was initialized during enteringDocument().

Throws:

SAXException - when an error occurs.

clear

public final void clear()

This method will clear the current result as well as calling IDocumentDataProvider.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

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException,
                                 IOException

Specified by:

resolveEntity in interface EntityResolver

Overrides:

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

Throws:

SAXException

IOException