Main Page   Packages   Namespace List   Class Hierarchy   Compound List   Compound Members  

Element Class Reference

List of all members.

Public Methods

 Element (String name, Namespace namespace)
 Element (String name)
 Element (String name, String uri)
 Element (String name, String prefix, String uri)
String getName ()
Element setName (String name)
Namespace getNamespace ()
Element setNamespace (Namespace namespace)
String getNamespacePrefix ()
String getNamespaceURI ()
Namespace getNamespace (String prefix)
String getQualifiedName ()
void addNamespaceDeclaration (Namespace additional)
void removeNamespaceDeclaration (Namespace additionalNamespace)
List getAdditionalNamespaces ()
Element getParent ()
Element detach ()
boolean isRootElement ()
Document getDocument ()
String getText ()
String getTextTrim ()
String getTextNormalize ()
String getChildText (String name)
String getChildTextTrim (String name)
String getChildTextNormalize (String name)
String getChildText (String name, Namespace ns)
String getChildTextTrim (String name, Namespace ns)
String getChildTextNormalize (String name, Namespace ns)
Element setText (String text)
List getContent ()
Element setContent (List newContent)
boolean hasChildren ()
List getChildren ()
Element setChildren (List children)
List getChildren (String name)
List getChildren (String name, Namespace ns)
Element getChild (String name, Namespace ns)
Element getChild (String name)
Element addContent (String str)
Element addContent (Text text)
Element addContent (CDATA cdata)
Element addContent (Element element)
Element addContent (ProcessingInstruction pi)
Element addContent (EntityRef entity)
Element addContent (Comment comment)
boolean isAncestor (Element element)
boolean removeChild (String name)
boolean removeChild (String name, Namespace ns)
boolean removeChildren (String name)
boolean removeChildren (String name, Namespace ns)
boolean removeChildren ()
List getAttributes ()
Attribute getAttribute (String name)
Attribute getAttribute (String name, Namespace ns)
String getAttributeValue (String name)
String getAttributeValue (String name, Namespace ns)
Element setAttributes (List newAttributes)
Element setAttribute (String name, String value)
Element setAttribute (String name, String value, Namespace ns)
Element setAttribute (Attribute attribute)
boolean removeAttribute (String name)
boolean removeAttribute (String name, Namespace ns)
boolean removeAttribute (Attribute attribute)
boolean removeContent (Element element)
boolean removeContent (ProcessingInstruction pi)
boolean removeContent (Comment comment)
boolean removeContent (CDATA cdata)
boolean removeContent (Text text)
boolean removeContent (EntityRef entity)
String toString ()
final boolean equals (Object ob)
final int hashCode ()
Object clone ()

Protected Methods

 Element ()
Element setParent (Element parent)
Element setDocument (Document document)

Protected Attributes

String name
transient List additionalNamespaces
Object parent
AttributeList attributes = new AttributeList(this)
ContentList content = new ContentList(this)

Detailed Description

Element defines behavior for an XML element, modeled in Java. Methods allow the user to obtain the value of the element's textual content, obtain its attributes, and get its children.

Author:
Brett McLaughlin , Jason Hunter , Lucas Gonze , Kevin Regan , Dan Schaffer , Yusuf Goolamabbas , Kent C. Johnson , Jools Enticknap , Alex Rosen , Bradley S. Huffman
Version:
Revision:
1.109
,
Date:
2002/02/14 05:33:17


Constructor & Destructor Documentation

Element::Element   [inline, protected]
 

This protected constructor is provided in order to support an Element subclass that wants full control over variable initialization. It intentionally leaves all instance variables null, allowing a lightweight subclass implementation. The subclass is responsible for ensuring all the get and set methods on Element behave as documented.

When implementing an Element subclass which doesn't require full control over variable initialization, be aware that simply calling super() (or letting the compiler add the implicit super() call) will not initialize the instance variables which will cause many of the methods to throw a NullPointerException. Therefore, the constructor for these subclasses should call one of the public constructors so variable initialization is handled automatically.

Element::Element String    name [inline]
 

This will create an Element in no Namespace.

Parameters:
name  String name of element.

Element::Element String    name,
String    uri
[inline]
 

This will create a new Element with the supplied (local) name, and specifies the URI of the Namespace the Element should be in, resulting it being unprefixed (in the default namespace).

Parameters:
name  String name of element.
uri  String URI for Namespace element should be in.

Element::Element String    name,
String    prefix,
String    uri
[inline]
 

This will create a new Element with the supplied (local) name, and specifies the prefix and URI of the Namespace the Element should be in.

Parameters:
name  String name of element.
uri  String URI for Namespace element should be in.


Member Function Documentation

Element Element::addContent Comment    comment [inline]
 

This adds a comment as content to this element.

Parameters:
comment  Comment to add
Returns:
this element modified
Exceptions:
IllegalAddException  if the given Comment already has a parent.

Element Element::addContent EntityRef    entity [inline]
 

This adds entity content to this element.

Parameters:
entity  EntityRef to add
Returns:
this element modified
Exceptions:
IllegalAddException  if the given EntityRef already has a parent.

Element Element::addContent ProcessingInstruction    pi [inline]
 

This adds a processing instruction as content to this element.

Parameters:
pi  ProcessingInstruction to add
Returns:
this element modified
Exceptions:
IllegalAddException  if the given processing instruction, pi, already has a parent.

Element Element::addContent Element    element [inline]
 

This adds element content to this element.

Parameters:
element  Element to add
Returns:
this element modified
Exceptions:
IllegalAddException  if the element you're attempting to add already has a parent element, or if you're attempting to add it as a descendent of itself (which would result in a recursive element definition!).

Element Element::addContent CDATA    cdata [inline]
 

This adds a CDATA section as content to this element.

Parameters:
cdata  CDATA to add
Returns:
this element modified

Element Element::addContent Text    text [inline]
 

This adds text content to this element. It does not replace the existing content as does setText().

Parameters:
text  Text to add
Returns:
this element modified

Element Element::addContent String    str [inline]
 

This adds text content to this element. It does not replace the existing content as does setText().

Parameters:
str  String to add
Returns:
this element modified

void Element::addNamespaceDeclaration Namespace    additional [inline]
 

This will add a namespace declarations to this element. This should not be used to add the declaration for this element itself; that should be assigned in the construction of the element. Instead, this is for adding namespace declarations on the element not relating directly to itself.

Parameters:
additional  Namespace to add.
Exceptions:
IllegalAddException  if the namespace prefix collides with another namespace prefix on the element.

Object Element::clone   [inline]
 

This returns a deep clone of this element. The new element is detached from its parent, and getParent() on the clone will return null.

Returns:
the clone of this element

Element Element::detach   [inline]
 

This detaches the element from its parent, or does nothing if the element has no parent.

Returns:
Element - this Element modified.

final boolean Element::equals Object    ob [inline]
 

This tests for equality of this Element to the supplied Object, explicitly using the == operator.

Parameters:
ob  Object to compare to
Returns:
whether the elements are equal

List Element::getAdditionalNamespaces   [inline]
 

This will return any namespace declarations on this element that exist, excluding the namespace of the element itself, which can be obtained through getNamespace. If there are no additional declarations, this returns an empty list. Note, the returned list is not live, for performance reasons.

Returns:
List - the additional namespace declarations.

Attribute Element::getAttribute String    name,
Namespace    ns
[inline]
 

This returns the attribute for this element with the given name and within the given Namespace, or null if no such attribute exists.

Parameters:
name  name of the attribute to return
ns  Namespace to search within
Returns:
attribute for the element

Attribute Element::getAttribute String    name [inline]
 

This returns the attribute for this element with the given name and within no namespace, or null if no such attribute exists.

Parameters:
name  name of the attribute to return
Returns:
attribute for the element

List Element::getAttributes   [inline]
 

This returns the complete set of attributes for this element, as a List of Attribute objects in no particular order, or an empty list if there are none. The returned list is "live" and changes to it affect the element's actual attributes.

Returns:
attributes for the element

String Element::getAttributeValue String    name,
Namespace    ns
[inline]
 

This returns the attribute value for the attribute with the given name and within the given Namespace, null if there is no such attribute, and the empty string if the attribute value is empty.

Parameters:
name  name of the attribute whose valud is to be returned
ns  Namespace to search within
Returns:
the named attribute's value, or null if no such attribute

String Element::getAttributeValue String    name [inline]
 

This returns the attribute value for the attribute with the given name and within no namespace, null if there is no such attribute, and the empty string if the attribute value is empty.

Parameters:
name  name of the attribute whose value to be returned
Returns:
the named attribute's value, or null if no such attribute

Element Element::getChild String    name [inline]
 

This returns the first child element within this element with the given local name and belonging to no namespace. If no elements exist for the specified name and namespace, null is returned.

Parameters:
name  local name of child element to match
Returns:
the first matching child element, or null if not found

Element Element::getChild String    name,
Namespace    ns
[inline]
 

This returns the first child element within this element with the given local name and belonging to the given namespace. If no elements exist for the specified name and namespace, null is returned.

Parameters:
name  local name of child element to match
ns  Namespace to search within
Returns:
the first matching child element, or null if not found

List Element::getChildren String    name,
Namespace    ns
[inline]
 

This returns a List of all the child elements nested directly (one level deep) within this element with the given local name and belonging to the given Namespace, returned as Element objects. If this target element has no nested elements with the given name in the given Namespace, an empty List is returned. The returned list is "live" in document order and changes to it affect the element's actual contents.

Please see the notes for getChildren for a code example.

Parameters:
name  local name for the children to match
ns  Namespace to search within
Returns:
all matching child elements

List Element::getChildren String    name [inline]
 

This returns a List of all the child elements nested directly (one level deep) within this element with the given local name and belonging to no namespace, returned as Element objects. If this target element has no nested elements with the given name outside a namespace, an empty List is returned. The returned list is "live" in document order and changes to it affect the element's actual contents.

Please see the notes for getChildren for a code example.

Parameters:
name  local name for the children to match
Returns:
all matching child elements

List Element::getChildren   [inline]
 

This returns a List of all the child elements nested directly (one level deep) within this element, as Element objects. If this target element has no nested elements, an empty List is returned. The returned list is "live" in document order and changes to it affect the element's actual contents.

Since getChildren always returns a "live" and modifiable list, even if the element contains no children, performance conscious users should call hasChildren first to check for content.

No recursion is performed, so elements nested two levels deep would have to be obtained with:

 
   List childern = currentElement.getChildren();
   for (int i = 0; i < childern.size(); i++) {
     Element oneLevelDeep = (Element)childern.get(i);
     List twoLevelsDeep = oneLevelDeep.getChildren();
     // Do something with these children
   }
 
 

Returns:
list of child Element objects for this element

String Element::getChildText String    name,
Namespace    ns
[inline]
 

This convenience method returns the textual content of the named child element, or returns null if there's no such child.

Parameters:
name  the name of the child
ns  the namespace of the child
Returns:
text content for the named child, or null if none

String Element::getChildText String    name [inline]
 

This convenience method returns the textual content of the named child element, or returns an empty String ("") if the child has no textual content. However, if the child does not exist, null is returned.

Parameters:
name  the name of the child
Returns:
text content for the named child, or null if none

String Element::getChildTextNormalize String    name,
Namespace    ns
[inline]
 

This convenience method returns the normalized textual content of the named child element, or returns null if there's no such child. See getTextNormalize for details of text normalizing.

Parameters:
name  the name of the child
ns  the namespace of the child
Returns:
normalized text content for the named child, or null if none

String Element::getChildTextNormalize String    name [inline]
 

This convenience method returns the normalized textual content of the named child element, or returns null if there's no such child. See getTextNormalize for details of text normalizing.

Parameters:
name  the name of the child
Returns:
normalized text content for the named child, or null if none

String Element::getChildTextTrim String    name,
Namespace    ns
[inline]
 

This convenience method returns the trimmed textual content of the named child element, or returns null if there's no such child. See getTextTrim for details of text trimming.

Parameters:
name  the name of the child
ns  the namespace of the child
Returns:
trimmed text content for the named child, or null if none

String Element::getChildTextTrim String    name [inline]
 

This convenience method returns the trimmed textual content of the named child element, or returns null if there's no such child. See getTextTrim for details of text trimming.

Parameters:
name  the name of the child
Returns:
trimmed text content for the named child, or null if none

List Element::getContent   [inline]
 

This returns the full content of the element as a List which may contain objects of type Text, Element, Comment, ProcessingInstruction, CDATA, and EntityRef. The List returned is "live" in document order and modifications to it affect the element's actual contents. Whitespace content is returned in its entirety.

Returns:
a List containing the mixed content of the element: may contain Text, Element, Comment, ProcessingInstruction, CDATA, and EntityRef objects.

Document Element::getDocument   [inline]
 

This retrieves the owning Document for this Element, or null if not a currently a member of a Document.

Returns:
Document owning this Element, or null.

String Element::getName   [inline]
 

This returns the (local) name of the Element, without any namespace prefix, if one exists.

Returns:
String - element name.

Namespace Element::getNamespace String    prefix [inline]
 

This returns the Namespace in scope on this element for the given prefix (this involves searching up the tree, so the results depend on the current location of the element). It returns null if there is no Namespace in scope with the given prefix at this point in the document.

Parameters:
prefix  namespace prefix to look up
Returns:
Namespace - namespace in scope for the given prefix on this Element, or null if none.

Namespace Element::getNamespace   [inline]
 

This will return this Element's Namespace.

Returns:
Namespace - Namespace object for this Element

String Element::getNamespacePrefix   [inline]
 

This returns the namespace prefix of the Element, if one exists. Otherwise, an empty String is returned.

Returns:
String - namespace prefix.

String Element::getNamespaceURI   [inline]
 

This returns the URI mapped to this Element's prefix (or the default namespace if no prefix). If no mapping is found, an empty String is returned.

Returns:
String - namespace URI for this Element.

Element Element::getParent   [inline]
 

This will return the parent of this Element. If there is no parent, then this returns null. Also note that on its own, this is not 100% sufficient to see if the Element is not in use - this should be used in tandem with isRootElement to determine this.

Returns:
parent of this Element.

String Element::getQualifiedName   [inline]
 

This returns the full name of the Element, in the form [namespacePrefix]:[localName]. If no namespace prefix exists for the Element, simply the local name is returned.

Returns:
String - full name of element.

String Element::getText   [inline]
 

This returns the textual content directly held under this element. This will include all text within this single element, including whitespace and CDATA sections if they exist. It's essentially the concatenation of all Text and CDATA nodes returned by getContent(). The call does not recurse into child elements. If no textual value exists for the element, an empty String ("") is returned.

Returns:
text content for this element, or empty string if none

String Element::getTextNormalize   [inline]
 

This returns the textual content of this element with all surrounding whitespace removed and internal whitespace normalized to a single space. If no textual value exists for the element, or if only whitespace exists, the empty string is returned.

Returns:
normalized text content for this element, or empty string if none

String Element::getTextTrim   [inline]
 

This returns the textual content of this element with all surrounding whitespace removed. If no textual value exists for the element, or if only whitespace exists, the empty string is returned.

Returns:
trimmed text content for this element, or empty string if none

boolean Element::hasChildren   [inline]
 

Test whether this element has a child element. This method can be used before a call to getContent, which always creates a "live" list, to improve performance.

Returns:
true if this element has at least one child element

final int Element::hashCode   [inline]
 

This returns the hash code for this Element.

Returns:
inherited hash code

boolean Element::isAncestor Element    element [inline]
 

Determines if this element is the ancestor of another element.

Parameters:
element  Element to check against
Returns:
true if this element is the ancestor of the supplied element

boolean Element::isRootElement   [inline]
 

This returns a boolean value indicating whether this Element is a root Element for a JDOM Document. This should be used in tandem with getParent to determine if an Element has no "attachments" to parents.

Returns:
boolean - whether this is a root element.

boolean Element::removeAttribute Attribute    attribute [inline]
 

This removes the supplied Attribute should it exist.

Parameters:
attribute  Reference to the attribute to be removed.
Returns:
whether the attribute was removed

boolean Element::removeAttribute String    name,
Namespace    ns
[inline]
 

This removes the attribute with the given name and within the given Namespace. If no such attribute exists, this method does nothing.

Parameters:
name  name of attribute to remove
ns  namespace URI of attribute to remove
Returns:
whether the attribute was removed

boolean Element::removeAttribute String    name [inline]
 

This removes the attribute with the given name and within no namespace. If no such attribute exists, this method does nothing.

Parameters:
name  name of attribute to remove
Returns:
whether the attribute was removed

boolean Element::removeChild String    name,
Namespace    ns
[inline]
 

This removes the first child element (one level deep) with the given local name and belonging to the given namespace. Returns true if a child was removed.

Parameters:
name  the name of child element to remove
ns  Namespace to search within
Returns:
whether deletion occurred

boolean Element::removeChild String    name [inline]
 

This removes the first child element (one level deep) with the given local name and belonging to no namespace. Returns true if a child was removed.

Parameters:
name  the name of child elements to remove
Returns:
whether deletion occurred

boolean Element::removeChildren   [inline]
 

This removes all child elements. Returns true if any were removed.

Returns:
whether deletion occurred

boolean Element::removeChildren String    name,
Namespace    ns
[inline]
 

This removes all child elements (one level deep) with the given local name and belonging to the given namespace. Returns true if any were removed.

Parameters:
name  the name of child elements to remove
ns  Namespace to search within
Returns:
whether deletion occurred

boolean Element::removeChildren String    name [inline]
 

This removes all child elements (one level deep) with the given local name and belonging to no namespace. Returns true if any were removed.

Parameters:
name  the name of child elements to remove
Returns:
whether deletion occurred

boolean Element::removeContent EntityRef    entity [inline]
 

This removes the specified EntityRef. If the specified EntityRef is not a child of this Element, this method does nothing.

Parameters:
child  EntityRef to delete
Returns:
whether deletion occurred

boolean Element::removeContent Text    text [inline]
 

This removes the specified Text. If the specified Text is not a child of this Element, this method does nothing.

Parameters:
text  Text to delete
Returns:
whether deletion occurred

boolean Element::removeContent CDATA    cdata [inline]
 

This removes the specified CDATA. If the specified CDATA is not a child of this Element, this method does nothing.

Parameters:
cdata  CDATA to delete
Returns:
whether deletion occurred

boolean Element::removeContent Comment    comment [inline]
 

This removes the specified Comment. If the specified Comment is not a child of this Element, this method does nothing.

Parameters:
comment  Comment to delete
Returns:
whether deletion occurred

boolean Element::removeContent ProcessingInstruction    pi [inline]
 

This removes the specified ProcessingInstruction. If the specified ProcessingInstruction is not a child of this Element, this method does nothing.

Parameters:
child  ProcessingInstruction to delete
Returns:
whether deletion occurred

boolean Element::removeContent Element    element [inline]
 

This removes the specified Element. If the specified Element is not a child of this Element, this method does nothing.

Parameters:
child  Element to delete
Returns:
whether deletion occurred

void Element::removeNamespaceDeclaration Namespace    additionalNamespace [inline]
 

This will remove a namespace declarations from this element. This should not be used to remove the declaration for this element itself; that should be handled in the construction of the element. Instead, this is for removing namespace declarations on the element not relating directly to itself. If the declaration is not present, this method does nothing.

Parameters:
additionalNamespace  Namespace to remove.

Element Element::setAttribute Attribute    attribute [inline]
 

This sets an attribute value for this element. Any existing attribute with the same name and namespace URI is removed.

Parameters:
attribute  Attribute to set
Returns:
this element modified
Exceptions:
IllegalAddException  if the attribute being added already has a parent or if the attribute namespace prefix collides with another namespace prefix on the element.

Element Element::setAttribute String    name,
String    value,
Namespace    ns
[inline]
 

This sets an attribute value for this element. Any existing attribute with the same name and namespace URI is removed.

Parameters:
name  name of the attribute to set
value  value of the attribute to set
ns  namespace of the attribute to set
Returns:
this element modified

Element Element::setAttribute String    name,
String    value
[inline]
 

This sets an attribute value for this element. Any existing attribute with the same name and namespace URI is removed.

Parameters:
name  name of the attribute to set
value  value of the attribute to set
Returns:
this element modified

Element Element::setAttributes List    newAttributes [inline]
 

This sets the attributes of the element. The supplied List should contain only objects of type Attribute.

When all objects in the supplied List are valid and before the new attributes is added, all objects in the old attributes will have their parentage set to null (no parent) and the old attributes list will be cleared. This has the effect that any active attribute list (previously obtained with a call to getAttributes) will also change to reflect the new attributes. In addition, all objects in the supplied List will have their parentage set to this element, but the List itself will not be "live" and further removals and additions will have no effect on this elements attributes. If the user wants to continue working with a "live" attribute list, then a call to setAttributes should be followed by a call to getAttributes to obtain a "live" version of the attributes.

Passing a null or empty List clears the existing attributes.

In cases where the List contains duplicate attributes, only the last one will be retained. This has the same effect as calling setAttribute sequentially.

In event of an exception the original attributes will be unchanged and the objects in the supplied attributes will be unaltered.

Parameters:
attributes  List of attributes to set
Returns:
this element modified
Exceptions:
IllegalAddException  if the List contains objects of illegal types.

Element Element::setChildren List    children [inline]
 

This sets the content of the element the same as setContent, except only Element objects are allowed in the supplied list.

Parameters:
children  List of Element objects to add
Returns:
this element modified

Element Element::setContent List    newContent [inline]
 

This sets the content of the element. The supplied List should contain only objects of type Element, Text, CDATA, Comment, ProcessingInstruction, and EntityRef.

When all objects in the supplied List are valid and before the new content is added, all objects in the old content will have their parentage set to null (no parent) and the old content list will be cleared. This has the effect that any active list (previously obtained with a call to getContent or getChildren) will also change to reflect the new content. In addition, all objects in the supplied List will have their parentage set to this element, but the List itself will not be "live" and further removals and additions will have no effect on this elements content. If the user wants to continue working with a "live" list, then a call to setContent should be followed by a call to getContent or getChildren to obtain a "live" version of the content.

Passing a null or empty List clears the existing content.

In event of an exception the original content will be unchanged and the objects in the supplied content will be unaltered.

Parameters:
newContent  List of content to set
Returns:
this element modified
Exceptions:
IllegalAddException  if the List contains objects of illegal types.

Element Element::setDocument Document    document [inline, protected]
 

This sets the Document parent of this element and makes it the root element. The caller is responsible for ensuring the element doesn't have a pre-existing parent.

Parameters:
document  Document parent
Returns:
Document this Element modified

Element Element::setName String    name [inline]
 

This sets the (local) name of the Element.

Returns:
Element - the element modified.
Exceptions:
IllegalNameException  if the given name is invalid as an Element name.

Element Element::setNamespace Namespace    namespace [inline]
 

This sets this Element's Namespace. If the provided namespace is null, the element will have no namespace.

Returns:
Element - the element modified.

Element Element::setParent Element    parent [inline, protected]
 

This will set the parent of this Element. The caller is responsible for handling pre-existing parentage.

Parameters:
parent  Element to be new parent.
Returns:
Element - this Element modified.

Element Element::setText String    text [inline]
 

This sets the content of the element to be the text given. All existing text content and non-text context is removed. If this element should have both textual content and nested elements, use setContent instead. Setting a null text value is equivalent to setting an empty string value.

Parameters:
text  new content for the element
Returns:
this element modified

String Element::toString   [inline]
 

This returns a String representation of the Element, suitable for debugging. If the XML representation of the Element is desired, XMLOutputter::outputString should be used.

Returns:
String - information about the Element


Member Data Documentation

transient List Element::additionalNamespaces [protected]
 

Additional Namespace declarations on this element

AttributeList Element::attributes = new AttributeList(this) [protected]
 

The attributes of the Element.

ContentList Element::content = new ContentList(this) [protected]
 

The mixed content of the Element.

String Element::name [protected]
 

The local name of the Element

Object Element::parent [protected]
 

Parent element, document, or null if none


The documentation for this class was generated from the following file:
Generated on Sat Mar 30 18:53:03 2002 for JDOM by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001