Element (PF-All 7.4.0 API)

java.lang.Object
- org.pfsw.six.Element

All Implemented Interfaces:

XmlItem
```
public class Element
extends java.lang.Object
implements XmlItem
```
Each element represents one tag occurrence in a XML stream. The element's name corresponds to the XML tag name.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.pfsw.six.XmlItem
  XmlItem.Type

Field Summary

Fields
Modifier and Type Field and Description

static Element[] EMPTY_ARRAY

protected static java.lang.String NAMESPACE_PREFIX

protected static java.lang.String NAMESPACE_SEPARATOR

Fields
Modifier and Type	Field and Description
`static Element[]`	`EMPTY_ARRAY`
`protected static java.lang.String`	`NAMESPACE_PREFIX`
`protected static java.lang.String`	`NAMESPACE_SEPARATOR`

Constructor Summary

Constructors
Constructor and Description
`Element()` Initialize the new instance with default values.
`Element(java.lang.String tagName)` Initialize the new instance with the given name.
`Element(java.lang.String tagName, java.lang.String text)` Initialize the new instance with the given name and text.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChild(Element childElement)` Adds the given element as a child to the receiver
`void`	`addChildItem(XmlItem item)` Adds the given item as a child to the receiver.
`protected java.util.List<Element>`	`collect(IElementFilter elementFilter, boolean recursive)` Returns all elements with the given tag name.
`protected java.util.List<Element>`	`collectContainedElements()`
`protected Element[]`	`collectElements(java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> attributes, boolean all)`
`Element`	`copy()` Returns a copy of the element with all child elements copied as well.
`Element`	`deepCopy()` Returns a deep copy of the element.
`protected java.util.Map<java.lang.String,java.lang.String>`	`detectNamespaceDeclarations()`
`Element[]`	`find(IElementFilter filter)` Returns all sub elements matching the given filter.
`Element[]`	`find(java.lang.String tagName)` Returns all sub elements with the given tag name plus this element, if it's name is equal to the given tagName.
`Element[]`	`find(java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> attributes)` Returns all sub elements with the given tag name and the specified attribute values plus this element if it matches the tagName and attributes.
`Element[]`	`findChildren(java.lang.String tagName)` Returns all children with the given tag name.
`Element[]`	`findChildren(java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> attributes)` Returns all children with the given tag name and the specified attribute values.
`Element`	`findFirst(IElementFilter filter)` Returns the first element in the hierarchy that matches the given filter or null if none matches.
`Element[]`	`findSubElements(java.lang.String tagName)` Returns all sub elements with the given tag name.
`Element[]`	`findSubElements(java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> attributes)` Returns all sub elements with the given tag name and the specified attribute values.
`java.lang.String`	`getAttribute(java.lang.String attrName)` Returns the value of the attribute with the given name.
`java.lang.String[]`	`getAttributeLocalNames()` Returns the names of all attributes assigned to this element.
`java.lang.String[]`	`getAttributeNames()` Returns the names of all attributes assigned to this element.
`protected java.lang.String[]`	`getAttributeNames(boolean withPrefix)`
`java.util.Map<java.lang.String,java.lang.String>`	`getAttributes()` Returns all attributes of this element.
`int`	`getChildItemCount()` Returns the number of contained child items.
`XmlItem[]`	`getChildItems()` Returns all children of all types.
`Element[]`	`getChildren()` Returns all direct child elements.
`Element[]`	`getChildren(IElementFilter elementFilter)` Returns all direct child elements that match the given filter.
`Element[]`	`getChildren(java.lang.String tagName)` Returns all direct child elements with the given tagName.
`int`	`getChildrenCount()` Returns the number of child elements.
`protected NamedTextList`	`getElementAttributes()`
`Element`	`getFirstChild()` Returns the first direct child element or null if there is no child element.
`Element`	`getFirstChild(IElementFilter elementFilter)` Returns the first child element that matches the given filter or null if there is no matching child element found.
`Element`	`getFirstChild(java.lang.String tagName)` Returns the first child element that matches the given filter or null if there is no matching child element found.
`protected java.util.List<XmlItem>`	`getInternalChildItems()`
`XmlItem.Type`	`getItemType()` Returns always Type.ELEMENT.
`java.lang.String`	`getLocalName()` Returns the local name of this element.
`protected java.lang.String`	`getLocalNameOf(java.lang.String aName)`
`java.lang.String`	`getName()` Returns the name of the element.
`java.lang.String`	`getNamePrefix()`
`protected java.lang.String`	`getNamePrefixOf(java.lang.String aName)`
`java.util.Map<java.lang.String,java.lang.String>`	`getNamespaceDeclarations()` Returns a map with the names of namespaces as keys and the corresponding namespace URIs as values.
`protected java.util.Map<java.lang.String,java.lang.String>`	`getNamespaces()`
`java.lang.String`	`getText()` Returns the elements textual content which corresponds to the XML tag's PCDATA.
`boolean`	`hasAttribute(java.lang.String attrName)` Returns true if the element has an attribute with the given name.
`boolean`	`hasAttributes()` Returns true if the element has any attribute.
`boolean`	`hasChildItems()` Returns true if the element has any child (Element or `XmlProcessingInstruction`).
`boolean`	`hasChildren()` Returns true if the element contains at least on child element.
`boolean`	`hasProcessingInstructions()` Returns true if the element contains at least one processing instruction.
`boolean`	`hasText()` Returns true if the element has any text.
`protected int`	`indexOfChild(XmlItem child)`
`protected void`	`insertAfter(int index, XmlItem item)` Inserts the given child after the given index
`protected void`	`insertBefore(int index, XmlItem item)` Inserts the given child before the given index
`boolean`	`insertChildAfter(XmlItem oldChild, XmlItem newChild)` Inserts the given newChild after the specified old child.
`boolean`	`insertChildBefore(XmlItem oldChild, XmlItem newChild)` Inserts the given newChild before the specified old child.
`protected boolean`	`matches(Element element, java.lang.String tagName, java.util.Map<java.lang.String,java.lang.String> attributes)`
`void`	`removeAllChildren()` Removes all children of this element.
`void`	`removeAttribute(java.lang.String attrName)` Removes the attribute with the specified name from the element's attribute list.
`boolean`	`removeChild(Element childElement)` Removes the given child from this element.
`boolean`	`removeChildItem(XmlItem item)` Removes the given child from this element.
`void`	`removeText()` Removes the element's text content.
`boolean`	`replaceChild(XmlItem oldChild, XmlItem newChild)` Replaces the given oldChild by the given newChild.
`void`	`setAttribute(java.lang.String attrName, java.lang.String value)` Sets the value of the attribute with the given name.
`protected void`	`setAttributes(NamedTextList newValue)`
`protected void`	`setChildItems(java.util.List<XmlItem> items)`
`void`	`setName(java.lang.String newName)` Set the element's name which corresponds to its XML tag name.
`protected void`	`setNamespaces(java.util.Map<java.lang.String,java.lang.String> newValue)`
`void`	`setText(java.lang.String newText)` Set the element's text.
`Element`	`shallowCopy()` Returns a shallow copy of the element, that is a new element with the same name, same attributes and same text but without children.
`protected StringUtil`	`str()`
`static Element[]`	`toArray(java.util.Collection<Element> elementCollection)` Returns an Element array that contains all Element objects of the given collection.
`static java.util.List<Element>`	`toList(Element[] elements)` Returns an ArrayList that contains all elements of the given array.
`java.lang.String`	`toString()` Returns the element's name as a XML tag.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_ARRAY
```
public static final Element[] EMPTY_ARRAY
```
  - NAMESPACE_SEPARATOR
```
protected static final java.lang.String NAMESPACE_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - NAMESPACE_PREFIX
```
protected static final java.lang.String NAMESPACE_PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Element
```
public Element()
```
    Initialize the new instance with default values.
  - Element
```
public Element(java.lang.String tagName)
```
    Initialize the new instance with the given name.
    
    Parameters:
    
    tagName - The name of the new element
  - Element
```
public Element(java.lang.String tagName,
               java.lang.String text)
```
    Initialize the new instance with the given name and text.
    
    Parameters:
    
    tagName - The name of the new element
    
    text - The text content of the new element
- Method Detail
  - toArray
```
public static Element[] toArray(java.util.Collection<Element> elementCollection)
```
    Returns an Element array that contains all Element objects of the given collection. If the given collection is null or empty an empty Element array will be returned.
    
    Parameters:
    
    elementCollection - The collection to be converted to an array.
    
    Throws:
    
    java.lang.ClassCastException - If any object in the given collection is not an Element.
  - toList
```
public static java.util.List<Element> toList(Element[] elements)
```
    Returns an ArrayList that contains all elements of the given array. If the given array is null or empty then an empty ArrayList will be returned.
    
    Parameters:
    
    elements - The array to convert to a list
  - getItemType
```
public XmlItem.Type getItemType()
```
    Returns always Type.ELEMENT.
    
    Specified by:
    
    getItemType in interface XmlItem
  - getName
```
public java.lang.String getName()
```
    Returns the name of the element. This name corresponds to the tag name in the XML representation of this element.
    
    Specified by:
    
    getName in interface XmlItem
  - setName
```
public void setName(java.lang.String newName)
```
    Set the element's name which corresponds to its XML tag name.
    
    Parameters:
    
    newName - Any valid XML tag name
  - getLocalName
```
public java.lang.String getLocalName()
```
    Returns the local name of this element. That is, without a namespace prefix.
  - getNamePrefix
```
public java.lang.String getNamePrefix()
```
  - getText
```
public java.lang.String getText()
```
    Returns the elements textual content which corresponds to the XML tag's PCDATA.
  - setText
```
public void setText(java.lang.String newText)
```
    Set the element's text.
    
    Parameters:
    
    newText - Any valid XML character data compliant to the desired encoding
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String attrName)
```
    Returns the value of the attribute with the given name. If the attribute is not set (not available) this method returns null.
    
    Parameters:
    
    attrName - The name of the attribute including a namespace prefix if applicable
  - setAttribute
```
public void setAttribute(java.lang.String attrName,
                         java.lang.String value)
```
    Sets the value of the attribute with the given name. If the attribute exists already its value will be changed to the new one.
    
    Parameters:
    
    attrName - The name of the attribute including a namespace prefix if applicable
    
    value - The value to assign to this attribute
  - removeAttribute
```
public void removeAttribute(java.lang.String attrName)
```
    Removes the attribute with the specified name from the element's attribute list.
    
    Parameters:
    
    attrName - The name of the attribute to remove (including namespace prefix)
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
```
    Returns all attributes of this element. This returned map may be modified, since it is a copy. To add or remove attributes will not change the attributes of this element. by Element.
  - getAttributeNames
```
public java.lang.String[] getAttributeNames()
```
    Returns the names of all attributes assigned to this element. If the element has no attribute an empty array will be returned. The returned names are qualified names, that means they may contain namespace prefixes.
  - getAttributeLocalNames
```
public java.lang.String[] getAttributeLocalNames()
```
    Returns the names of all attributes assigned to this element. If the element has no attribute an empty array will be returned. The returned names are local names, that means they don't contain namespace prefixes.
  - getChildItemCount
```
public int getChildItemCount()
```
    Returns the number of contained child items.
  - getChildrenCount
```
public int getChildrenCount()
```
    Returns the number of child elements.
  - getChildren
```
public Element[] getChildren()
```
    Returns all direct child elements.
  - getChildren
```
public Element[] getChildren(java.lang.String tagName)
```
    Returns all direct child elements with the given tagName.
  - getChildren
```
public Element[] getChildren(IElementFilter elementFilter)
```
    Returns all direct child elements that match the given filter.
  - getFirstChild
```
public Element getFirstChild()
```
    Returns the first direct child element or null if there is no child element.
  - getFirstChild
```
public Element getFirstChild(java.lang.String tagName)
```
    Returns the first child element that matches the given filter or null if there is no matching child element found.
  - getFirstChild
```
public Element getFirstChild(IElementFilter elementFilter)
```
    Returns the first child element that matches the given filter or null if there is no matching child element found.
  - hasChildItems
```
public boolean hasChildItems()
```
    Returns true if the element has any child (Element or XmlProcessingInstruction). For more specific item types see hasChildren() and hasProcessingInstructions().
  - hasChildren
```
public boolean hasChildren()
```
    Returns true if the element contains at least on child element. That does NOT include processing instructions.
  - hasProcessingInstructions
```
public boolean hasProcessingInstructions()
```
    Returns true if the element contains at least one processing instruction.
  - removeChild
```
public boolean removeChild(Element childElement)
```
    Removes the given child from this element. The child itself must be in the children list. That is, comparison is done by == rather than equals().
    
    Parameters:
    
    childElement - The child element to be removed
    
    Returns:
    
    true if the child element was found and removed
  - removeChildItem
```
public boolean removeChildItem(XmlItem item)
```
    Removes the given child from this element. The child itself must be in the children list. That is, comparison is done by == rather than equals().
    
    Parameters:
    
    item - The child element to be removed
    
    Returns:
    
    true if the child element was found and removed
  - removeAllChildren
```
public void removeAllChildren()
```
    Removes all children of this element. That includes all types Element and XmlProcessingInstruction).
  - removeText
```
public void removeText()
```
    Removes the element's text content.
  - hasText
```
public boolean hasText()
```
    Returns true if the element has any text.
  - hasAttributes
```
public boolean hasAttributes()
```
    Returns true if the element has any attribute.
  - hasAttribute
```
public boolean hasAttribute(java.lang.String attrName)
```
    Returns true if the element has an attribute with the given name.
  - toString
```
public java.lang.String toString()
```
    Returns the element's name as a XML tag. Example: ""
    
    Overrides:
    
    toString in class java.lang.Object
  - addChild
```
public void addChild(Element childElement)
```
    Adds the given element as a child to the receiver
    
    Parameters:
    
    childElement - The element to add
  - addChildItem
```
public void addChildItem(XmlItem item)
```
    Adds the given item as a child to the receiver.
    
    Parameters:
    
    item - The item to add.
  - insertChildAfter
```
public boolean insertChildAfter(XmlItem oldChild,
                                XmlItem newChild)
```
    Inserts the given newChild after the specified old child. Returns true if the old child was found and the new child successfully inserted after it.
  - insertChildBefore
```
public boolean insertChildBefore(XmlItem oldChild,
                                 XmlItem newChild)
```
    Inserts the given newChild before the specified old child. Returns true if the old child was found and the new child successfully inserted after it.
  - replaceChild
```
public boolean replaceChild(XmlItem oldChild,
                            XmlItem newChild)
```
    Replaces the given oldChild by the given newChild. Returns true if the old child was found and replaced.
  - findFirst
```
public Element findFirst(IElementFilter filter)
```
    Returns the first element in the hierarchy that matches the given filter or null if none matches.
    
    Parameters:
    
    filter - The filter that defines which elements match (must not be null).
    
    Returns:
    
    The found element or null.
  - find
```
public Element[] find(IElementFilter filter)
```
    Returns all sub elements matching the given filter. This method returns all matching elements down the whole hierarchy.
    
    Parameters:
    
    filter - The filter that defines which elements match (must not be null).
    
    Returns:
    
    An array of elements (never null).
  - find
```
public Element[] find(java.lang.String tagName)
```
    Returns all sub elements with the given tag name plus this element, if it's name is equal to the given tagName. This method returns all matching elements down the whole hierarchy.
    
    Returns:
    
    An array of elements (never null)
  - find
```
public Element[] find(java.lang.String tagName,
                      java.util.Map<java.lang.String,java.lang.String> attributes)
```
    Returns all sub elements with the given tag name and the specified attribute values plus this element if it matches the tagName and attributes. This method returns all matching elements down the whole hierarchy.
    
    Parameters:
    
    tagName - The name of the elements to be found (must not be null).
    
    attributes - Definition of attributes the elements must match (may be null).
    
    Returns:
    
    An array of elements (never null)
  - findSubElements
```
public Element[] findSubElements(java.lang.String tagName)
```
    Returns all sub elements with the given tag name. That is, all direct children and children of those children and so on. It goes down recursively the whole hierarchy.
    
    Returns:
    
    An array of elements (never null)
  - findSubElements
```
public Element[] findSubElements(java.lang.String tagName,
                                 java.util.Map<java.lang.String,java.lang.String> attributes)
```
    Returns all sub elements with the given tag name and the specified attribute values. That is, all direct children and children of those children and so on. It goes down recursively the whole hierarchy.
  - findChildren
```
public Element[] findChildren(java.lang.String tagName)
```
    Returns all children with the given tag name. This method returns only direct children of this element. It does not go deeper into the hierarchy.
    
    Returns:
    
    An array of elements (never null)
  - findChildren
```
public Element[] findChildren(java.lang.String tagName,
                              java.util.Map<java.lang.String,java.lang.String> attributes)
```
    Returns all children with the given tag name and the specified attribute values. This method returns only direct children of this element. It does not go deeper into the hierarchy.
    
    Returns:
    
    An array of elements (never null)
  - shallowCopy
```
public Element shallowCopy()
```
    Returns a shallow copy of the element, that is a new element with the same name, same attributes and same text but without children.
  - deepCopy
```
public Element deepCopy()
```
    Returns a deep copy of the element. That is a new element with the same name, same attributes, the same text and with a copy of all child elements.
  - copy
```
public Element copy()
```
    Returns a copy of the element with all child elements copied as well. This is a deep copy.
    
    See Also:
    
    deepCopy()
  - getNamespaceDeclarations
```
public java.util.Map<java.lang.String,java.lang.String> getNamespaceDeclarations()
```
    Returns a map with the names of namespaces as keys and the corresponding namespace URIs as values. The map contains only those namespace definitions that are set by attributes of this element. If no namespace is declared in this element the returned map is empty.
  - getChildItems
```
public XmlItem[] getChildItems()
```
    Returns all children of all types. That is Elements and XmlProcessinGinstructions.
  - collect
```
protected java.util.List<Element> collect(IElementFilter elementFilter,
                                          boolean recursive)
```
    Returns all elements with the given tag name.
  - collectElements
```
protected Element[] collectElements(java.lang.String tagName,
                                    java.util.Map<java.lang.String,java.lang.String> attributes,
                                    boolean all)
```
  - setChildItems
```
protected void setChildItems(java.util.List<XmlItem> items)
```
  - matches
```
protected boolean matches(Element element,
                          java.lang.String tagName,
                          java.util.Map<java.lang.String,java.lang.String> attributes)
```
  - detectNamespaceDeclarations
```
protected java.util.Map<java.lang.String,java.lang.String> detectNamespaceDeclarations()
```
  - indexOfChild
```
protected int indexOfChild(XmlItem child)
```
  - insertAfter
```
protected void insertAfter(int index,
                           XmlItem item)
```
    Inserts the given child after the given index
  - insertBefore
```
protected void insertBefore(int index,
                            XmlItem item)
```
    Inserts the given child before the given index
  - getAttributeNames
```
protected java.lang.String[] getAttributeNames(boolean withPrefix)
```
  - getNamePrefixOf
```
protected java.lang.String getNamePrefixOf(java.lang.String aName)
```
  - getLocalNameOf
```
protected java.lang.String getLocalNameOf(java.lang.String aName)
```
  - getInternalChildItems
```
protected java.util.List<XmlItem> getInternalChildItems()
```
  - collectContainedElements
```
protected java.util.List<Element> collectContainedElements()
```
  - getElementAttributes
```
protected NamedTextList getElementAttributes()
```
  - setAttributes
```
protected void setAttributes(NamedTextList newValue)
```
  - getNamespaces
```
protected java.util.Map<java.lang.String,java.lang.String> getNamespaces()
```
  - setNamespaces
```
protected void setNamespaces(java.util.Map<java.lang.String,java.lang.String> newValue)
```
  - str
```
protected StringUtil str()
```

Class Element

Nested Class Summary

Nested classes/interfaces inherited from interface org.pfsw.six.XmlItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

NAMESPACE_SEPARATOR

NAMESPACE_PREFIX

Constructor Detail

Element

Element

Element

Method Detail

toArray

toList

getItemType

getName

setName

getLocalName

getNamePrefix

getText

setText

getAttribute

setAttribute

removeAttribute

getAttributes

getAttributeNames

getAttributeLocalNames

getChildItemCount

getChildrenCount

getChildren

getChildren

getChildren

getFirstChild

getFirstChild

getFirstChild

hasChildItems

hasChildren

hasProcessingInstructions

removeChild

removeChildItem

removeAllChildren

removeText

hasText

hasAttributes

hasAttribute

toString

addChild

addChildItem

insertChildAfter

insertChildBefore

replaceChild

findFirst

find

find

find

findSubElements

findSubElements

findChildren

findChildren

shallowCopy

deepCopy

copy

getNamespaceDeclarations

getChildItems

collect

collectElements

setChildItems

matches

detectNamespaceDeclarations

indexOfChild

insertAfter

insertBefore

getAttributeNames

getNamePrefixOf

getLocalNameOf

getInternalChildItems