org.jupnp.xml

Class DOMElement<CHILD extends DOMElement,PARENT extends DOMElement>

java.lang.Object

org.jupnp.xml.DOMElement<CHILD,PARENT>

public abstract class DOMElement<CHILD extends DOMElement,PARENT extends DOMElement>
extends Object

Wraps a W3C element.

Using XPath for simple queries like "get all children with attribute value X" is actually slower than iterating with the W3C API. We still use XPath because there is a small chance that the authors of the XML implementation in the JDK will not get forced by Larry to fix their ugly code and APIs. Yes, it' s unlikely but one can dream...

Author:

Christian Bauer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DOMElement.ArrayBuilder<T extends DOMElement>
class	DOMElement.Builder<T extends DOMElement>

Field Summary

Fields

Modifier and Type	Field and Description
DOMElement.ArrayBuilder<CHILD>	CHILD_BUILDER
DOMElement.Builder<PARENT>	PARENT_BUILDER

Constructor Summary

Constructors

Constructor and Description
DOMElement(XPath xpath, Element element)

Method Summary

Modifier and Type	Method and Description
protected CHILD	adoptOrImport(Document document, CHILD child, boolean copy)
CHILD	appendChild(CHILD el, boolean copy)
CHILD	createChild(String name)
CHILD	createChild(String name, String namespaceURI)
protected abstract DOMElement.ArrayBuilder<CHILD>	createChildBuilder(DOMElement el)
protected abstract DOMElement.Builder<PARENT>	createParentBuilder(DOMElement el)
CHILD[]	findChildren(String name)
CHILD	findChildWithIdentifier(String id)
String	getAttribute(String attribute)
CHILD[]	getChildren()
CHILD[]	getChildren(String name)
String	getContent()
String	getElementName()
CHILD	getFirstChild(String name)
PARENT	getParent()
CHILD	getRequiredChild(String name)
Element	getW3CElement()
XPath	getXpath()
CHILD	getXPathChildElement(DOMElement.Builder<CHILD> builder, String expr)
Collection<CHILD>	getXPathChildElements(DOMElement.Builder<CHILD> builder, String expr)
Collection	getXPathElements(DOMElement.Builder builder, String expr)
PARENT	getXPathParentElement(DOMElement.Builder<PARENT> builder, String expr)
Collection<PARENT>	getXPathParentElements(DOMElement.Builder<CHILD> builder, String expr)
Object	getXPathResult(Node context, String expr, QName result)
Object	getXPathResult(String expr, QName result)
String	getXPathString(XPath xpath, String expr)
protected String	prefix(String localName)
void	removeChild(CHILD el)
void	removeChildren()
CHILD	replaceChild(CHILD original, CHILD replacement, boolean copy)
void	replaceEqualChild(DOMElement source, String identifier)
DOMElement	setAttribute(String attribute, String value)
DOMElement<CHILD,PARENT>	setContent(String content)
String	toSimpleXMLString()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARENT_BUILDER

public final DOMElement.Builder<PARENT extends DOMElement> PARENT_BUILDER

CHILD_BUILDER

public final DOMElement.ArrayBuilder<CHILD extends DOMElement> CHILD_BUILDER

Constructor Detail

DOMElement

public DOMElement(XPath xpath,
                  Element element)

Method Detail

getW3CElement

public Element getW3CElement()

getElementName

public String getElementName()

getContent

public String getContent()

setContent

public DOMElement<CHILD,PARENT> setContent(String content)

getAttribute

public String getAttribute(String attribute)

setAttribute

public DOMElement setAttribute(String attribute,
                               String value)

getParent

public PARENT getParent()

getChildren

public CHILD[] getChildren()

getChildren

public CHILD[] getChildren(String name)

getRequiredChild

public CHILD getRequiredChild(String name)
                       throws ParserException

Throws:

ParserException

findChildren

public CHILD[] findChildren(String name)

findChildWithIdentifier

public CHILD findChildWithIdentifier(String id)

getFirstChild

public CHILD getFirstChild(String name)

createChild

public CHILD createChild(String name)

createChild

public CHILD createChild(String name,
                         String namespaceURI)

appendChild

public CHILD appendChild(CHILD el,
                         boolean copy)

replaceChild

public CHILD replaceChild(CHILD original,
                          CHILD replacement,
                          boolean copy)

replaceEqualChild

public void replaceEqualChild(DOMElement source,
                              String identifier)

removeChild

public void removeChild(CHILD el)

removeChildren

public void removeChildren()

adoptOrImport

protected CHILD adoptOrImport(Document document,
                              CHILD child,
                              boolean copy)

createParentBuilder

protected abstract DOMElement.Builder<PARENT> createParentBuilder(DOMElement el)

createChildBuilder

protected abstract DOMElement.ArrayBuilder<CHILD> createChildBuilder(DOMElement el)

toSimpleXMLString

public String toSimpleXMLString()

toString

public String toString()

Overrides:

toString in class Object

getXpath

public XPath getXpath()

prefix

protected String prefix(String localName)

getXPathParentElements

public Collection<PARENT> getXPathParentElements(DOMElement.Builder<CHILD> builder,
                                                 String expr)

getXPathChildElements

public Collection<CHILD> getXPathChildElements(DOMElement.Builder<CHILD> builder,
                                               String expr)

getXPathParentElement

public PARENT getXPathParentElement(DOMElement.Builder<PARENT> builder,
                                    String expr)

getXPathChildElement

public CHILD getXPathChildElement(DOMElement.Builder<CHILD> builder,
                                  String expr)

getXPathElements

public Collection getXPathElements(DOMElement.Builder builder,
                                   String expr)

getXPathString

public String getXPathString(XPath xpath,
                             String expr)

getXPathResult

public Object getXPathResult(String expr,
                             QName result)

getXPathResult

public Object getXPathResult(Node context,
                             String expr,
                             QName result)