org.x4o.xml.element

Class AbstractElement

java.lang.Object

org.x4o.xml.element.AbstractElement

All Implemented Interfaces:

Element

Direct Known Subclasses:

AttributeAliasElement, BeanElement, DefaultElement, DefaultElementBodyComment, DefaultElementBodyWhitespace, DescriptionElement, ElementClassAddParentElement, ModuleElement, NextAttributeElement, SkipPhaseElement

public abstract class AbstractElement
extends Object
implements Element

An AbstractElement.

Version:

1.0 Aug 8, 2005

Author:

Willem Cazander

Nested Class Summary

Nested classes/interfaces inherited from interface org.x4o.xml.element.Element

Element.ElementType

Constructor Summary

Constructors

Constructor and Description
AbstractElement()

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(Element element) Adds an Elment as child of this element.
void	doCharacters(String characters) Sets the body texts on an event based system.
void	doComment(String comment) Sets the comment texts on an event based system.
void	doElementEnd() This method is fired when the end xml tag is parsed.
void	doElementRun() This method is fired only once in the run phase.
void	doElementStart() This method is fired when the start of xml tag is parsed.
void	doIgnorableWhitespace(String space) Is called when there is whitespace in xml.
List<Element>	getAllChilderen() Gets the childeren elements including those which are comment and white space.
Map<String,String>	getAttributes() Gets the xml attributes.
List<Element>	getChilderen() Gets the childeren elements.
ElementClass	getElementClass() Gets the ElementClass.
Object	getElementObject() Gives back the object this Element has made and configed. So other elements can do stuff to that object.
Element.ElementType	getElementType() Gets the Element type.
X4OLanguageContext	getLanguageContext() Gets the ElementLanguage.
Element	getParent() Returns the parent Element. Or null when there is no parent Element.
boolean	isTransformingTree() Defaults to false.
void	release() Cleans the attributes and elements(class) and context.
void	removeChild(Element element) Removes an Elment as child of this element.
void	setAttribute(String name, String value) Sets the xml attributes.
void	setElementClass(ElementClass elementClass) Sets the ElementClass.
void	setElementObject(Object object) Sets the object which we control.
void	setLanguageContext(X4OLanguageContext elementLanguage) Sets the ElementLanguage.
void	setParent(Element element) Set the parent Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractElement

public AbstractElement()

Method Detail

doElementStart

public void doElementStart()
                    throws ElementException

Description copied from interface: Element

This method is fired when the start of xml tag is parsed.

Specified by:

doElementStart in interface Element

Throws:

ElementException - Can be thrown when structure is not correct.

See Also:

Element.doElementStart()

doElementEnd

public void doElementEnd()
                  throws ElementException

Description copied from interface: Element

This method is fired when the end xml tag is parsed.

Specified by:

doElementEnd in interface Element

Throws:

ElementException - Can be thrown when structure is not correct.

See Also:

Element.doElementEnd()

doElementRun

public void doElementRun()
                  throws ElementException

Description copied from interface: Element

This method is fired only once in the run phase.

Specified by:

doElementRun in interface Element

Throws:

ElementException - Can be thrown when structure is not correct.

See Also:

Element.doElementRun()

setParent

public void setParent(Element element)

Description copied from interface: Element

Set the parent Element.

Specified by:

setParent in interface Element

Parameters:

element - The paraent Element to set.

See Also:

Element.setParent(Element)

getParent

public Element getParent()

Description copied from interface: Element

Returns the parent Element.
Or null when there is no parent Element.

Specified by:

getParent in interface Element

Returns:

Returns the parent Element

See Also:

Element.getParent()

release

public void release()
             throws ElementException

Cleans the attributes and elements(class) and context.

Specified by:

release in interface Element

Throws:

ElementException - Can be thrown when structure is not correct.

See Also:

Element.release()

getElementObject

public Object getElementObject()

Description copied from interface: Element

Gives back the object this Element has made and configed.
So other elements can do stuff to that object.

Specified by:

getElementObject in interface Element

Returns:

An Object.

See Also:

Element.getElementObject()

setElementObject

public void setElementObject(Object object)

Description copied from interface: Element

Sets the object which we control.

Specified by:

setElementObject in interface Element

Parameters:

object - The object to configed by this element.

See Also:

Element.setElementObject(Object)

setLanguageContext

public void setLanguageContext(X4OLanguageContext elementLanguage)

Description copied from interface: Element

Sets the ElementLanguage.

Specified by:

setLanguageContext in interface Element

Parameters:

elementLanguage - The ElementLanguage to set.

See Also:

Element.setLanguageContext(X4OLanguageContext)

getLanguageContext

public X4OLanguageContext getLanguageContext()

Description copied from interface: Element

Gets the ElementLanguage.

Specified by:

getLanguageContext in interface Element

Returns:

Returns the ElementLanguage.

See Also:

Element.getLanguageContext()

doCharacters

public void doCharacters(String characters)
                  throws ElementException

Description copied from interface: Element

Sets the body texts on an event based system.

Specified by:

doCharacters in interface Element

Parameters:

characters - The body text.

Throws:

ElementException - Can be thrown when structure is not correct.

See Also:

Element.doCharacters(java.lang.String)

doComment

public void doComment(String comment)
               throws ElementException

Description copied from interface: Element

Sets the comment texts on an event based system.

Specified by:

doComment in interface Element

Parameters:

comment - The comment text.

Throws:

ElementException - Can be thrown when structure is not correct.

See Also:

Element.doComment(java.lang.String)

doIgnorableWhitespace

public void doIgnorableWhitespace(String space)
                           throws ElementException

Description copied from interface: Element

Is called when there is whitespace in xml.

Specified by:

doIgnorableWhitespace in interface Element

Parameters:

space - The space.

Throws:

ElementException - Can be thrown when structure is not correct.

See Also:

Element.doIgnorableWhitespace(java.lang.String)

setElementClass

public void setElementClass(ElementClass elementClass)

Description copied from interface: Element

Sets the ElementClass.

Specified by:

setElementClass in interface Element

Parameters:

elementClass - The ElementClass to set.

See Also:

Element.setElementClass(ElementClass)

getElementClass

public ElementClass getElementClass()

Description copied from interface: Element

Gets the ElementClass.

Specified by:

getElementClass in interface Element

Returns:

Returns the ElementClass.

See Also:

Element.getElementClass()

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: Element

Gets the xml attributes.

Specified by:

getAttributes in interface Element

Returns:

Returns the xml attributes.

See Also:

Element.getAttributes()

setAttribute

public void setAttribute(String name,
                String value)

Description copied from interface: Element

Sets the xml attributes.

Specified by:

setAttribute in interface Element

Parameters:

name - The name to set.

value - The value to set.

See Also:

Element.setAttribute(java.lang.String, java.lang.String)

getChilderen

public List<Element> getChilderen()

Description copied from interface: Element

Gets the childeren elements.

Specified by:

getChilderen in interface Element

Returns:

Returns the childeren.

See Also:

Element.getChilderen()

addChild

public void addChild(Element element)

Description copied from interface: Element

Adds an Elment as child of this element.

Specified by:

addChild in interface Element

Parameters:

element - The child to add.

See Also:

Element.addChild(Element)

removeChild

public void removeChild(Element element)

Description copied from interface: Element

Removes an Elment as child of this element.

Specified by:

removeChild in interface Element

Parameters:

element - The child to remove.

See Also:

Element.removeChild(Element)

getAllChilderen

public List<Element> getAllChilderen()

Description copied from interface: Element

Gets the childeren elements including those which are comment and white space. (text)

Specified by:

getAllChilderen in interface Element

Returns:

Returns all the childeren.

See Also:

Element.getAllChilderen()

getElementType

public Element.ElementType getElementType()

Description copied from interface: Element

Gets the Element type.

Specified by:

getElementType in interface Element

Returns:

Returns the ElementType.

See Also:

Element.getElementType()

isTransformingTree

public boolean isTransformingTree()

Defaults to false.

Specified by:

isTransformingTree in interface Element

Returns:

Returns true if transforming tree.

See Also:

Element.isTransformingTree()