de.saxsys.svgfx.xml.elements

Class ElementBase<TDataProvider extends IDataProvider,TResult,TParent extends ElementBase<TDataProvider,?,?>>

java.lang.Object

de.saxsys.svgfx.xml.elements.ElementBase<TDataProvider,TResult,TParent>

Type Parameters:

TDataProvider - the type of the IDataProvider to be used

TResult - the type of result provided by the element

TParent - the type of parent of this element

Direct Known Subclasses:

SVGElementBase

public abstract class ElementBase<TDataProvider extends IDataProvider,TResult,TParent extends ElementBase<TDataProvider,?,?>>
extends Object

Represents an actual element of the parsed document from an SAXParser.

Author:

Xyanid on 24.10.2015.

Constructor Summary

Constructors

Constructor and Description
ElementBase(String name, Attributes attributes, TParent parent, TDataProvider dataProvider) Creates a new instance of he element using the given attributes, parent and dataProvider.

Method Summary

Modifier and Type	Method and Description
abstract void	endProcessing() Will be called when the end of the element was been reached and thus the processing is finished.
String	getAttribute(String key) returns the attributes with the given key.
Map<String,String>	getAttributes() Gets the attribute map as an unmodifiable map.
List<ElementBase>	getChildren() Gets the children.
TDataProvider	getDataProvider() Gets the dataProvider.
String	getName() Gets the value of the property.
TParent	getParent() Gets the parent.
abstract TResult	getResult() Returns the result for the current element.
abstract void	processCharacterData(char[] ch, int start, int length) Will be called when character data (CDATA) is read for an element.
abstract void	startProcessing() Will be called when an element is started that represents this element.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementBase

public ElementBase(String name,
                   Attributes attributes,
                   TParent parent,
                   TDataProvider dataProvider)
            throws IllegalArgumentException

Creates a new instance of he element using the given attributes, parent and dataProvider.

Parameters:

name - value of the element, must not be null

attributes - attributes to be used

parent - parent of the element

dataProvider - dataProvider to be used, must not be null

Throws:

IllegalArgumentException - if either value or dataProvider are null

Method Detail

getName

public String getName()

Gets the value of the property.

Returns:

the name of the element

getAttributes

public final Map<String,String> getAttributes()

Gets the attribute map as an unmodifiable map.

Returns:

the map of the attributes

getParent

public TParent getParent()

Gets the parent.

Returns:

the parent

getChildren

public List<ElementBase> getChildren()

Gets the children.

Returns:

the children

getDataProvider

public TDataProvider getDataProvider()

Gets the dataProvider.

Returns:

the dataProvider

getResult

public abstract TResult getResult()
                           throws SAXException

Returns the result for the current element.

Returns:

result for the element

Throws:

SAXException - will be thrown when an error occurs retrieving the result

getAttribute

public String getAttribute(String key)

returns the attributes with the given key.

Parameters:

key - key of the attribute

Returns:

the value of the attribute with the given key or null if it does not exist

startProcessing

public abstract void startProcessing()
                              throws SAXException

Will be called when an element is started that represents this element.

Throws:

SAXException - will be thrown when an error occurs during processing

processCharacterData

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

Will be called when character data (CDATA) is read for an element.

Parameters:

ch - The characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - will be thrown when an error occurs during processing the characters

endProcessing

public abstract void endProcessing()
                            throws SAXException

Will be called when the end of the element was been reached and thus the processing is finished.

Throws:

SAXException - will be thrown when an error occurs during processing

toString

public String toString()

Overrides:

toString in class Object