de.init.its.api.ds
Interface IitsTagElement

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ItsTagElement

public interface IitsTagElement
extends java.io.Serializable


Method Summary
 void addAllAttributes(java.util.Collection<IitsAttribute> attributes)
          Adds all attributes to this ITS tag Element
 void addAttribute(IitsAttribute itsAttribute)
          adds an its attribute to the element
 void addAttribute(ItsAttributes dcname, java.lang.String dcvalue)
          adds an its attribute to the element
 void addAttribute(java.lang.String dcname, java.lang.String dcvalue)
          adds an its attribute to the element
 void addChild(IitsTagElement element)
          Adds an IITagsElement to this element
 java.util.List<IitsAttribute> getAttributes()
          Returns a list of all its attributes
 java.util.List<IitsTagElement> getChildren()
          Returns all child its tag elements, if any
 IitsId getId()
          Returns the id of this element
 IitsTagElement getLastChild()
          returns the last inserted child from this element
 IitsTagElement getNextChild()
          returns the next IitsTagElement
 IitsTagElement getParentElement()
          returns the parent element
 boolean hasChildren()
          Returns if this Element has any child nodes
 boolean hasMoreChildren()
          returns true if there are more child elements available
 boolean hasParent()
          Returns true if this element has a parent element
 boolean isEmpty()
          Returns true, if this element is an orphan (has no parent nor children nor any values)
 boolean isParent()
          returns true if this element is parent
 boolean isRoot()
          Returns true if this tag element is the root element (eg. is parent and has no parent element)
 void removeChild(IitsTagElement child)
          Removes a child from this branch.
 java.util.Map<ItsAttributes,java.util.List<java.lang.String>> renderAttributes()
          Convenience method to render all attributes as map
 void reset()
          resets the iterator
 void setId(IitsId id)
          Sets the id of this its element
 void setParent(boolean parent)
          set this element as parent
 void setParentElement(IitsTagElement e)
          Sets the ItsTageElements parent
 void update(java.util.Map<ItsAttributes,java.util.List<java.lang.String>> values)
          Updates this elements values
 

Method Detail

addChild

void addChild(IitsTagElement element)
Adds an IITagsElement to this element

Parameters:
element -

removeChild

void removeChild(IitsTagElement child)
Removes a child from this branch. No further operation is done here eg. all children will NOT be moved one level up.

Parameters:
child -

getChildren

java.util.List<IitsTagElement> getChildren()
Returns all child its tag elements, if any

Returns:

hasChildren

boolean hasChildren()
Returns if this Element has any child nodes

Returns:

isEmpty

boolean isEmpty()
Returns true, if this element is an orphan (has no parent nor children nor any values)

Returns:

getId

IitsId getId()
Returns the id of this element

Returns:

setId

void setId(IitsId id)
Sets the id of this its element

Parameters:
id -

getNextChild

IitsTagElement getNextChild()
returns the next IitsTagElement

Returns:

hasMoreChildren

boolean hasMoreChildren()
returns true if there are more child elements available

Returns:

getParentElement

IitsTagElement getParentElement()
returns the parent element

Returns:

setParentElement

void setParentElement(IitsTagElement e)
Sets the ItsTageElements parent

Parameters:
e -

isParent

boolean isParent()
returns true if this element is parent

Returns:

hasParent

boolean hasParent()
Returns true if this element has a parent element

Returns:
true, if element has parent

isRoot

boolean isRoot()
Returns true if this tag element is the root element (eg. is parent and has no parent element)

Returns:
true if element is root element

setParent

void setParent(boolean parent)
set this element as parent

Parameters:
parent -

getAttributes

java.util.List<IitsAttribute> getAttributes()
Returns a list of all its attributes

Returns:

renderAttributes

java.util.Map<ItsAttributes,java.util.List<java.lang.String>> renderAttributes()
Convenience method to render all attributes as map

Returns:

addAttribute

void addAttribute(IitsAttribute itsAttribute)
adds an its attribute to the element

Parameters:
itsAttribute -

addAttribute

void addAttribute(java.lang.String dcname,
                  java.lang.String dcvalue)
adds an its attribute to the element

Parameters:
dcname - the name of the data category attribute
dcvalue - the value of the data category attribute

addAttribute

void addAttribute(ItsAttributes dcname,
                  java.lang.String dcvalue)
adds an its attribute to the element

Parameters:
dcname - the name of the data category attribute
dcvalue - the value of the data category attribute

addAllAttributes

void addAllAttributes(java.util.Collection<IitsAttribute> attributes)
Adds all attributes to this ITS tag Element

Parameters:
attributes - a collection of IitsAttribute

getLastChild

IitsTagElement getLastChild()
returns the last inserted child from this element

Returns:
IitsTagElement

update

void update(java.util.Map<ItsAttributes,java.util.List<java.lang.String>> values)
Updates this elements values

Parameters:
values -

reset

void reset()
resets the iterator