org.x4o.xml.element

Interface Element

All Known Implementing Classes:

AbstractElement, AttributeAliasElement, BeanElement, DefaultElement, DefaultElementBodyCharacters, DefaultElementBodyComment, DefaultElementBodyWhitespace, DescriptionElement, ElementClassAddParentElement, ELReferenceElement, MethodElement, ModuleElement, NextAttributeElement, ParentObjectElement, PropertyElement, SkipPhaseElement

public interface Element

Defines an XML element with an object.

The main function is to store the ElementObject.
Also we can configure the ElementObject from differted events hooks. from the attibutes or parent (object)element.

Version:

1.0 01/02/2005

Author:

Willem Cazander

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Element.ElementType The ElementTypes which are possible.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(Element element) Adds an Elment as child of this element.
void	doCharacters(String body) 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.
ElementLanguage	getElementLanguage() Gets the ElementLanguage.
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.
Element	getParent() Returns the parent Element. Or null when there is no parent Element.
boolean	isTransformingTree() Returns if this elements transforms the tree.
void	release() This method get called when this Element object is not needed anymore. Can be used to close resources.
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	setElementLanguage(ElementLanguage elementLanguage) Sets the ElementLanguage.
void	setElementObject(Object object) Sets the object which we control.
void	setParent(Element element) Set the parent Element.

Method Detail

doElementEnd

void doElementEnd()
                  throws ElementException

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

Throws:

ElementException

doElementStart

void doElementStart()
                    throws ElementException

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

Throws:

ElementException

doElementRun

void doElementRun()
                  throws ElementException

This method is fired only once in the run phase.

Throws:

ElementException

setParent

void setParent(Element element)

Set the parent Element.

Parameters:

element - The paraent Element to set.

getParent

Element getParent()

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

Returns:

Returns the parent Element

release

void release()
             throws ElementException

This method get called when this Element object is not needed anymore.
Can be used to close resources.

Throws:

ElementException

getElementObject

Object getElementObject()

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

Returns:

An Object.

setElementObject

void setElementObject(Object object)

Sets the object which we control.

Parameters:

object - The object to configed by this element.

setElementLanguage

void setElementLanguage(ElementLanguage elementLanguage)

Sets the ElementLanguage.

Parameters:

elementLanguage - The ElementLanguage to set.

getElementLanguage

ElementLanguage getElementLanguage()

Gets the ElementLanguage.

Returns:

Returns the ElementLanguage.

doCharacters

void doCharacters(String body)
                  throws ElementException

Sets the body texts on an event based system.

Parameters:

body - The body text.

Throws:

ElementException

doComment

void doComment(String comment)
               throws ElementException

Sets the comment texts on an event based system.

Parameters:

comment - The comment text.

Throws:

ElementException

doIgnorableWhitespace

void doIgnorableWhitespace(String space)
                           throws ElementException

Is called when there is whitespace in xml.

Parameters:

space - The space.

Throws:

ElementException

setElementClass

void setElementClass(ElementClass elementClass)

Sets the ElementClass.

Parameters:

elementClass - The ElementClass to set.

getElementClass

ElementClass getElementClass()

Gets the ElementClass.

Returns:

Returns the ElementClass.

setAttribute

void setAttribute(String name,
                String value)

Sets the xml attributes.

Parameters:

name - The name to set.

value - The value to set.

getAttributes

Map<String,String> getAttributes()

Gets the xml attributes.

Returns:

Returns the xml attributes.

getChilderen

List<Element> getChilderen()

Gets the childeren elements.

Returns:

Returns the childeren.

getAllChilderen

List<Element> getAllChilderen()

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

Returns:

Returns all the childeren.

addChild

void addChild(Element element)

Adds an Elment as child of this element.

Parameters:

element - The child to add.

removeChild

void removeChild(Element element)

Removes an Elment as child of this element.

Parameters:

element - The child to remove.

getElementType

Element.ElementType getElementType()

Gets the Element type.

Returns:

Returns the ElementType.

isTransformingTree

boolean isTransformingTree()

Returns if this elements transforms the tree. if true the the doElementRun is runned in the transform phase insteat of the run phase. You need to add those new or modified Elements to the DirtyElement for reparsering.

Returns:

Returns true if transforming tree.