|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.cdmckay.coffeedom.Content org.cdmckay.coffeedom.Element
public class Element
An XML element. Methods allow the user to get and manipulate its child elements and content, directly access the element's textual content, manipulate its attributes, and manage namespaces.
Field Summary | |
---|---|
protected List<Namespace> |
additionalNamespaces
Additional namespace declarations to store on this element; useful during output |
protected String |
name
The local name of the element |
protected Namespace |
namespace
The namespace of the element |
Fields inherited from class org.cdmckay.coffeedom.Content |
---|
parent |
Constructor Summary | |
---|---|
protected |
Element()
This protected constructor is provided in order to support an Element subclass that wants full control over variable initialization. |
|
Element(String name)
Create a new element with the supplied (local) name and no namespace. |
|
Element(String name,
Namespace namespace)
Creates a new element with the supplied (local) name and namespace. |
|
Element(String name,
String uri)
Creates a new element with the supplied (local) name and a namespace given by a URI. |
|
Element(String name,
String prefix,
String uri)
Creates a new element with the supplied (local) name and a namespace given by the supplied prefix and URI combination. |
Method Summary | |
---|---|
Element |
addContent(Content child)
Appends the child to the end of the element's content list. |
Element |
addContent(int index,
Content child)
Inserts the child into the content list at the given index. |
Element |
addContent(String str)
This adds text content to this element. |
Element |
addContents(Collection<? extends Content> newContents)
Appends all children in the given collection to the end of the content list. |
Element |
addContents(int index,
Collection<? extends Content> newContents)
Inserts the content in a collection into the content list at the given index. |
void |
addNamespaceDeclaration(Namespace additionalNamespace)
Adds a namespace declarations to this element. |
Element |
clone()
This returns a deep clone of this element. |
List<Content> |
cloneContents()
Returns a list containing detached clones of this parent's content list. |
Element |
detach()
Detaches this child from its parent or does nothing if the child has no parent. |
List<Namespace> |
getAdditionalNamespaces()
Returns a list of the additional namespace declarations on this element. |
Attribute |
getAttribute(String name)
This returns the attribute for this element with the given name and within no namespace, or null if no such attribute exists. |
Attribute |
getAttribute(String name,
Namespace ns)
This returns the attribute for this element with the given name and within the given Namespace, or null if no such attribute exists. |
List<Attribute> |
getAttributes()
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. |
String |
getAttributeValue(String name)
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. |
String |
getAttributeValue(String name,
Namespace ns)
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. |
String |
getAttributeValue(String name,
Namespace ns,
String def)
This returns the attribute value for the attribute with the given name and within the given Namespace, or the passed-in default if there is no such attribute. |
String |
getAttributeValue(String name,
String def)
This returns the attribute value for the attribute with the given name and within no namespace, or the passed-in default if there is no such attribute. |
Element |
getChild(String name)
This returns the first child element within this element with the given local name and belonging to no namespace. |
Element |
getChild(String name,
Namespace ns)
This returns the first child element within this element with the given local name and belonging to the given namespace. |
List<Element> |
getChildren()
This returns a List of all the child elements nested directly (one level deep) within this element,
as Element objects. |
List<Element> |
getChildren(String name)
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. |
List<Element> |
getChildren(String name,
Namespace ns)
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. |
String |
getChildText(String name)
Returns the textual content of the named child element, or null if there's no such child. |
String |
getChildText(String name,
Namespace ns)
Returns the textual content of the named child element, or null if there's no such child. |
String |
getChildTextNormalize(String name)
Returns the normalized textual content of the named child element, or null if there's no such child. |
String |
getChildTextNormalize(String name,
Namespace ns)
Returns the normalized textual content of the named child element, or null if there's no such child. |
String |
getChildTextTrim(String name)
Returns the trimmed textual content of the named child element, or null if there's no such child. |
String |
getChildTextTrim(String name,
Namespace ns)
Returns the trimmed textual content of the named child element, or null if there's no such child. |
Content |
getContent(int index)
Returns the child at the given index. |
List<Content> |
getContents()
This returns the full content of the element as a List which may contain objects of type Text ,
Element , Comment , ProcessingInstruction , CDATA , and
EntityRef . |
List<Content> |
getContents(Filter filter)
Return a filter view of this Element 's content. |
int |
getContentsSize()
Returns the number of children in this parent's content list. |
Iterable<Content> |
getDescendants()
Returns an iterator that walks over all descendants in document order. |
Iterable<Content> |
getDescendants(Filter filter)
Returns an iterator that walks over all descendants in document order applying the Filter to return only elements that match the filter rule. |
String |
getName()
Returns the (local) name of the element (without any namespace prefix). |
Namespace |
getNamespace()
Returns the element's Namespace . |
Namespace |
getNamespace(String prefix)
Returns the Namespace corresponding to the given prefix in scope for this element. |
String |
getNamespacePrefix()
Returns the namespace prefix of the element or an empty string if none exists. |
String |
getNamespaceURI()
Returns the namespace URI mapped to this element's prefix (or the in-scope default namespace URI if no prefix). |
String |
getQualifiedName()
Returns the full name of the element, in the form [namespacePrefix]:[localName]. |
String |
getText()
Returns the textual content directly held under this element as a string. |
String |
getTextNormalize()
Returns the textual content of this element with all surrounding whitespace removed and internal whitespace normalized to a single space. |
String |
getTextTrim()
Returns the textual content of this element with all surrounding whitespace removed. |
String |
getValue()
Returns the XPath 1.0 string value of this element, which is the complete, ordered content of all text node descendants of this element (i.e. the text that's left after all references are resolved and all other markup is stripped out.) |
int |
indexOf(Content child)
Returns the index of the supplied child in the content list, or -1 if not a child of this parent. |
boolean |
isAncestor(Element element)
Determines if this element is the ancestor of another element. |
boolean |
isRootElement()
Returns whether this element is a root element. |
boolean |
removeAttribute(Attribute attribute)
This removes the supplied Attribute should it exist. |
boolean |
removeAttribute(String name)
This removes the attribute with the given name and within no namespace. |
boolean |
removeAttribute(String name,
Namespace ns)
This removes the attribute with the given name and within the given Namespace. |
boolean |
removeChild(String name)
This removes the first child element (one level deep) with the given local name and belonging to no namespace. |
boolean |
removeChild(String name,
Namespace ns)
This removes the first child element (one level deep) with the given local name and belonging to the given namespace. |
boolean |
removeChildren(String name)
This removes all child elements (one level deep) with the given local name and belonging to no namespace. |
boolean |
removeChildren(String name,
Namespace ns)
This removes all child elements (one level deep) with the given local name and belonging to the given namespace. |
boolean |
removeContent(Content child)
Removes a single child node from the content list. |
Content |
removeContent(int index)
Removes and returns the child at the given index, or returns null if there's no such child. |
List<Content> |
removeContents()
Removes all child content from this parent. |
List<Content> |
removeContents(Filter filter)
Remove all child content from this parent matching the supplied filter. |
void |
removeNamespaceDeclaration(Namespace additionalNamespace)
Removes an additional namespace declarations from this element. |
Element |
setAttribute(Attribute attribute)
This sets an attribute value for this element. |
Element |
setAttribute(String name,
String value)
This sets an attribute value for this element. |
Element |
setAttribute(String name,
String value,
Namespace ns)
This sets an attribute value for this element. |
Element |
setAttributes(Collection<? extends Attribute> newAttributes)
This sets the attributes of the element. |
Element |
setContent(Content child)
Set this element's content to be the supplied child. |
Element |
setContent(int index,
Content child)
Replace the current child the given index with the supplied child. |
Element |
setContents(Collection<? extends Content> newContents)
This sets the content of the element. |
Parent |
setContents(int index,
Collection<? extends Content> newContents)
Replace the child at the given index whith the supplied collection. |
Element |
setName(String name)
Sets the (local) name of the element. |
Element |
setNamespace(Namespace namespace)
Sets the element's Namespace . |
protected Element |
setParent(Parent parent)
Sets the parent of this Content. |
Element |
setText(String text)
Sets the content of the element to be the text given. |
String |
toString()
This returns a String representation of the Element , suitable for debugging. |
Methods inherited from class org.cdmckay.coffeedom.Content |
---|
equals, getDocument, getParent, getParentElement, hashCode |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.cdmckay.coffeedom.Parent |
---|
getDocument, getParent |
Field Detail |
---|
protected String name
protected transient Namespace namespace
protected transient List<Namespace> additionalNamespaces
Constructor Detail |
---|
protected Element()
public Element(String name, Namespace namespace)
name
- local name of the elementnamespace
- namespace for the element
IllegalNameException
- if the given name is illegal as an element namepublic Element(String name)
name
- local name of the element
IllegalNameException
- if the given name is illegal as an element name.public Element(String name, String uri)
name
- name of the elementuri
- namespace URI for the element
IllegalNameException
- if the given name is illegal as an element name or the given URI is illegal as a
namespace URIpublic Element(String name, String prefix, String uri)
name
- local name of the elementprefix
- namespace prefixuri
- namespace URI for the element
IllegalNameException
- if the given name is illegal as an element name, the given prefix is illegal as a
namespace prefix, or the given URI is illegal as a namespace URIMethod Detail |
---|
public String getName()
public Element setName(String name)
name
- the new (local) name of the element
IllegalNameException
- if the given name is illegal as an Element namepublic Namespace getNamespace()
Namespace
.
public Element setNamespace(Namespace namespace)
Namespace
. If the provided namespace is null, the element will have no namespace.
namespace
- the new namespace
protected Element setParent(Parent parent)
Content
setParent
in class Content
parent
- new parent element
public String getNamespacePrefix()
public String getNamespaceURI()
public Namespace getNamespace(String prefix)
Namespace
corresponding to the given prefix in scope for this element. This involves
searching up the tree, so the results depend on the current location of the element. Returns null if there is no
namespace in scope with the given prefix at this point in the document.
prefix
- namespace prefix to look up
public String getQualifiedName()
public void addNamespaceDeclaration(Namespace additionalNamespace)
additionalNamespace
- namespace to add
IllegalAddException
- if the namespace prefix collides with another namespace prefix on the elementpublic void removeNamespaceDeclaration(Namespace additionalNamespace)
additionalNamespace
- namespace to removepublic List<Namespace> getAdditionalNamespaces()
getNamespace()
. If there are no
additional declarations, this returns an empty list. Note, the returned list is unmodifiable.
public String getValue()
getValue
in class Content
public boolean isRootElement()
Content.getParent()
to determine
if an element has any "attachments" to a parent element or document.
public int getContentsSize()
Parent
Content
type.
getContentsSize
in interface Parent
public int indexOf(Content child)
Parent
indexOf
in interface Parent
child
- child to search for
public String getText()
Text
and CDATA
nodes returned by getContents()
. The call does not recurse into child
elements. If no textual value exists for the element, an empty string is returned.
public String getTextTrim()
public String getTextNormalize()
public String getChildText(String name)
getChild().getText()
can throw a NullPointerException.
name
- the name of the child
public String getChildTextTrim(String name)
getTextTrim()
for details of text trimming.
name
- the name of the child
public String getChildTextNormalize(String name)
getTextNormalize()
for details of text normalizing.
name
- the name of the child
public String getChildText(String name, Namespace ns)
name
- the name of the childns
- the namespace of the child
public String getChildTextTrim(String name, Namespace ns)
name
- the name of the childns
- the namespace of the child
public String getChildTextNormalize(String name, Namespace ns)
name
- the name of the childns
- the namespace of the child
public Element setText(String text)
setContent(Content)
instead. Setting a null text value is equivalent to setting an empty string value.
text
- new text content for the element
IllegalDataException
- if the assigned text contains an illegal character such as a vertical tab (as
determined by Verifier.checkCharacterData(String)
)public List<Content> getContents()
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. Sequential traversal through the List is best done with an Iterator since the underlying implement of List.size() may require walking the entire list.
getContents
in interface Parent
List
containing the mixed content of the element: may contain Text
,
Element
, Comment
, ProcessingInstruction
,
CDATA
, and EntityRef
objects.public List<Content> getContents(Filter filter)
Element
's content. Sequential traversal through the List is best done with a Iterator since the underlying implement of List.size() may require walking the entire list.
getContents
in interface Parent
filter
- Filter
to apply
List
- filtered Element contentpublic List<Content> removeContents()
removeContents
in interface Parent
public List<Content> removeContents(Filter filter)
removeContents
in interface Parent
filter
- filter to select which content to remove
public Element setContents(Collection<? extends Content> newContents)
Element
, Text
, CDATA
, Comment
,
ProcessingInstruction
, and EntityRef
. When all objects in the supplied List
are legal 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 getContents()
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 getContents()
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.
newContents
- Collection
of content to set
IllegalAddException
- if the List contains objects of illegal types or with existing parentage.public Element setContent(int index, Content child)
In event of an exception the original content will be unchanged and the supplied child will be unaltered.
index
- - index of child to replace.child
- - child to add.
IllegalAddException
- if the supplied child is already attached or not legal content for this
parent.
IndexOutOfBoundsException
- if index is negative or greater than the current number of children.public Parent setContents(int index, Collection<? extends Content> newContents)
In event of an exception the original content will be unchanged and the content in the supplied collection will be unaltered.
index
- index of child to replace.newContents
- Collection
of content to replace child.
IllegalAddException
- if the collection contains objects of illegal types.
IndexOutOfBoundsException
- if index is negative or greater than the current number of children.public Element addContent(String str)
setText()
.
str
- String
to add
IllegalDataException
- if str
contains an illegal character such as a vertical tab (as
determined by Verifier.checkCharacterData(String)
)public Element addContent(Content child)
child
- child to append to end of content list
IllegalAddException
- if the given child already has a parent.public Element addContents(Collection<? extends Content> newContents)
newContents
- Collection
of content to append
IllegalAddException
- if any item in the collection already has a parent or is of an inappropriate type.public Element addContent(int index, Content child)
index
- location for adding the collectionchild
- child to insert
IndexOutOfBoundsException
- if index is negative or beyond the current number of children
IllegalAddException
- if the given child already has a parent.public Element addContents(int index, Collection<? extends Content> newContents)
index
- location for adding the collectionnewContents
- Collection
of content to insert
IndexOutOfBoundsException
- if index is negative or beyond the current number of children
IllegalAddException
- if any item in the collection already has a parent or is of an inappropriate
type.public List<Content> cloneContents()
Parent
cloneContents
in interface Parent
public Content getContent(int index)
Parent
getContent
in interface Parent
index
- location of desired child
public boolean removeContent(Content child)
Parent
removeContent
in interface Parent
child
- child to remove
public Content removeContent(int index)
Parent
removeContent
in interface Parent
index
- index of child to remove
public Element setContent(Content child)
getContents()
methods will also change to reflect the new content. In addition, all content in the supplied collection will
have their parentage set to this parent. If the user wants to continue working with a "live" list of this
parent's child, then a call to setContent should be followed by a call to one of the getContents()
methods
to obtain a "live" version of the children.
Passing a null child clears the existing content.
In event of an exception the original content will be unchanged and the supplied child will be unaltered.
child
- new content to replace existing content
IllegalAddException
- if the supplied child is already attached or not legal content for an Elementpublic boolean isAncestor(Element element)
element
- Element
to check against
true
if this element is the ancestor of the supplied elementpublic List<Attribute> getAttributes()
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.
public Attribute getAttribute(String name)
This returns the attribute for this element with the given name and within no namespace, or null if no such attribute exists.
name
- name of the attribute to return
public Attribute getAttribute(String name, Namespace ns)
This returns the attribute for this element with the given name and within the given Namespace, or null if no such attribute exists.
name
- name of the attribute to returnns
- Namespace
to search within
public String getAttributeValue(String name)
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.
name
- name of the attribute whose value to be returned
public String getAttributeValue(String name, String def)
This returns the attribute value for the attribute with the given name and within no namespace, or the passed-in default if there is no such attribute.
name
- name of the attribute whose value to be returneddef
- a default value to return if the attribute does not exist
public String getAttributeValue(String name, Namespace ns)
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.
name
- name of the attribute whose valud is to be returnedns
- Namespace
to search within
public String getAttributeValue(String name, Namespace ns, String def)
This returns the attribute value for the attribute with the given name and within the given Namespace, or the passed-in default if there is no such attribute.
name
- name of the attribute whose valud is to be returnedns
- Namespace
to search withindef
- a default value to return if the attribute does not exist
public Element setAttributes(Collection<? extends Attribute> newAttributes)
This sets the attributes of the element. The supplied Collection should contain only objects of type
Attribute
.
When all objects in the supplied List are legal and before the new
attributes are added, all old attributes will have their parentage set to null (no parent) and the old attribute
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 attributes 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(Attribute)
sequentially.
In event of an exception the original attributes will be unchanged and the attributes in the supplied attributes will be unaltered.
newAttributes
- Collection
of attributes to set
IllegalAddException
- if the List contains objects that are not instances of Attribute
, or if
any of the Attribute
objects have conflicting namespace prefixes.public Element setAttribute(String name, String value)
This sets an attribute value for this element. Any existing attribute with the same name and namespace URI is removed.
name
- name of the attribute to setvalue
- value of the attribute to set
IllegalNameException
- if the given name is illegal as an attribute name.
IllegalDataException
- if the given attribute value is illegal character data (as determined by Verifier.checkCharacterData(String)
).public Element setAttribute(String name, String value, Namespace ns)
This sets an attribute value for this element. Any existing attribute with the same name and namespace URI is removed.
name
- name of the attribute to setvalue
- value of the attribute to setns
- namespace of the attribute to set
IllegalNameException
- if the given name is illegal as an attribute name, or if the namespace is an
unprefixed default namespace
IllegalDataException
- if the given attribute value is illegal character data (as determined by Verifier.checkCharacterData(String)
).
IllegalAddException
- if the attribute namespace prefix collides with another namespace prefix on the
element.public Element setAttribute(Attribute attribute)
This sets an attribute value for this element. Any existing attribute with the same name and namespace URI is removed.
attribute
- Attribute
to set
IllegalAddException
- if the attribute being added already has a parent or if the attribute namespace
prefix collides with another namespace prefix on the element.public boolean removeAttribute(String name)
This removes the attribute with the given name and within no namespace. If no such attribute exists, this method does nothing.
name
- name of attribute to remove
public boolean removeAttribute(String name, Namespace ns)
This removes the attribute with the given name and within the given Namespace. If no such attribute exists, this method does nothing.
name
- name of attribute to removens
- namespace URI of attribute to remove
public boolean removeAttribute(Attribute attribute)
This removes the supplied Attribute should it exist.
attribute
- Reference to the attribute to be removed.
public String toString()
This returns a String
representation of the Element
, suitable for debugging. If the
XML representation of the Element
is desired, XMLOutputter.outputString(Element)
should be used.
toString
in class Object
String
- information about the Element
public Element clone()
This returns a deep clone of this element. The new element is detached from its parent, and getParent() on the clone will return null.
clone
in interface Parent
clone
in class Content
public Element detach()
Content
detach
in class Content
public Iterable<Content> getDescendants()
getDescendants
in interface Parent
public Iterable<Content> getDescendants(Filter filter)
getDescendants
in interface Parent
filter
- filter to select which descendants to see
public List<Element> getChildren()
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. Sequential traversal through the List is best done with a Iterator since the underlying implement of List.size() may not be the most efficient.
No recursion is performed, so elements nested two levels deep would have to be obtained with:
Iterator itr = (currentElement.getChildren()).iterator();
while(itr.hasNext()) {
Element oneLevelDeep = (Element)itr.next();
List twoLevelsDeep = oneLevelDeep.getChildren();
// Do something with these children
}
Element
objects for this elementpublic List<Element> getChildren(String name)
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
for a code example. getChildren()
name
- local name for the children to match
public List<Element> getChildren(String name, Namespace ns)
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
for a code example. getChildren()
name
- local name for the children to matchns
- Namespace
to search within
public Element getChild(String name, Namespace ns)
name
- local name of child element to matchns
- Namespace
to search within
public Element getChild(String name)
name
- local name of child element to match
public boolean removeChild(String name)
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.
name
- the name of child elements to remove
public boolean removeChild(String name, Namespace ns)
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.
name
- the name of child element to removens
- Namespace
to search within
public boolean removeChildren(String name)
This removes all child elements (one level deep) with the given local name and belonging to no namespace. Returns true if any were removed.
name
- the name of child elements to remove
public boolean removeChildren(String name, Namespace ns)
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.
name
- the name of child elements to removens
- Namespace
to search within
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |