org.dom4j

Class Namespace

Implemented Interfaces:
Cloneable, Node, Serializable

public class Namespace
extends org.dom4j.tree.AbstractNode

Namespace is a Flyweight Namespace that can be shared amongst nodes.
Version:
$Revision: 1.22 $
Author:
James Strachan

Field Summary

protected static org.dom4j.tree.NamespaceCache
CACHE
Cache of Namespace instances
static Namespace
NO_NAMESPACE
No Namespace present
static Namespace
XML_NAMESPACE
XML Namespace

Fields inherited from class org.dom4j.tree.AbstractNode

NODE_TYPE_NAMES

Fields inherited from interface org.dom4j.Node

ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE

Constructor Summary

Namespace(String prefix, String uri)
DOCUMENT ME!

Method Summary

void
accept(Visitor visitor)
accept is the method used in the Visitor Pattern.
String
asXML()
asXML returns the textual XML representation of this node.
protected int
createHashCode()
Factory method to create the hashcode allowing derived classes to change the behaviour
protected Node
createXPathResult(Element parent)
boolean
equals(Object object)
Checks whether this Namespace equals the given Namespace.
static Namespace
get(String uri)
A helper method to return the Namespace instance for no prefix and the URI
static Namespace
get(String prefix, String uri)
A helper method to return the Namespace instance for the given prefix and URI
short
getNodeType()
Returns the code according to the type of node.
String
getPath(Element context)
Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c.
String
getPrefix()
DOCUMENT ME!
String
getStringValue()
Returns the XPath string-value of this node.
String
getText()
Returns the text of this node.
String
getURI()
DOCUMENT ME!
String
getUniquePath(Element context)
Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node.
String
getXPathNameStep()
int
hashCode()
DOCUMENT ME!
String
toString()

Methods inherited from class org.dom4j.tree.AbstractNode

asXPathResult, clone, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getDocument, getDocumentFactory, getName, getNodeType, getNodeTypeName, getParent, getPath, getStringValue, getText, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf, write

Field Details

CACHE

protected static final org.dom4j.tree.NamespaceCache CACHE
Cache of Namespace instances

NO_NAMESPACE

public static final Namespace NO_NAMESPACE
No Namespace present

XML_NAMESPACE

public static final Namespace XML_NAMESPACE
XML Namespace

Constructor Details

Namespace

public Namespace(String prefix,
                 String uri)
DOCUMENT ME!
Parameters:
prefix - is the prefix for this namespace
uri - is the URI for this namespace

Method Details

accept

public void accept(Visitor visitor)
accept is the method used in the Visitor Pattern.
Specified by:
accept in interface Node
Parameters:
visitor - is the visitor in the Visitor Pattern

asXML

public String asXML()
asXML returns the textual XML representation of this node.
Specified by:
asXML in interface Node
Returns:
the XML representation of this node

createHashCode

protected int createHashCode()
Factory method to create the hashcode allowing derived classes to change the behaviour
Returns:
DOCUMENT ME!

createXPathResult

protected Node createXPathResult(Element parent)
Overrides:
createXPathResult in interface org.dom4j.tree.AbstractNode

equals

public boolean equals(Object object)
Checks whether this Namespace equals the given Namespace. Two Namespaces are equals if their URI and prefix are equal.
Parameters:
object - DOCUMENT ME!
Returns:
DOCUMENT ME!

get

public static Namespace get(String uri)
A helper method to return the Namespace instance for no prefix and the URI
Parameters:
uri - DOCUMENT ME!
Returns:
an interned Namespace object

get

public static Namespace get(String prefix,
                            String uri)
A helper method to return the Namespace instance for the given prefix and URI
Parameters:
prefix - DOCUMENT ME!
uri - DOCUMENT ME!
Returns:
an interned Namespace object

getNodeType

public short getNodeType()
Returns the code according to the type of node. This makes processing nodes polymorphically much easier as the switch statement can be used instead of multiple if (instanceof) statements.
Specified by:
getNodeType in interface Node
Overrides:
getNodeType in interface org.dom4j.tree.AbstractNode
Returns:
a W3C DOM complient code for the node type such as ELEMENT_NODE or ATTRIBUTE_NODE

getPath

public String getPath(Element context)
Returns the relative XPath expression which will return a node set containing the given node such as a/b/@c. No indexing will be used to restrict the path if multiple elements with the same name occur on the path.
Specified by:
getPath in interface Node
Parameters:
context - is the parent context from which the relative path should start. If the context is null or the context is not an ancestor of this node then the path will be absolute and start from the document and so begin with the '/' character.
Returns:
the XPath expression relative to the given context which will return a nodeset containing at least this node.

getPrefix

public String getPrefix()
DOCUMENT ME!
Returns:
the prefix for this Namespace.

getStringValue

public String getStringValue()
Specified by:
getStringValue in interface Node
Overrides:
getStringValue in interface org.dom4j.tree.AbstractNode
Returns:
the text from all the child Text and Element nodes appended together.

getText

public String getText()
Returns the text of this node.
Specified by:
getText in interface Node
Overrides:
getText in interface org.dom4j.tree.AbstractNode
Returns:
the text for this node.

getURI

public String getURI()
DOCUMENT ME!
Returns:
the URI for this Namespace.

getUniquePath

public String getUniquePath(Element context)
Returns the relative unique XPath expression from the given context which will return a nodeset of one node which is the current node. This method will use the XPath index operator to restrict the path if multiple elements with the same name occur on the path.
Specified by:
getUniquePath in interface Node
Parameters:
context - is the parent context from which the path should start. If the context is null or the context is not an ancestor of this node then the path will start from the document and so begin with the '/' character.
Returns:
the XPath expression relative to the given context which will return a nodeset containing just this node.

getXPathNameStep

public String getXPathNameStep()

hashCode

public int hashCode()
DOCUMENT ME!
Returns:
the hash code based on the qualified name and the URI of the namespace.

toString

public String toString()

Copyright B) 2005 MetaStuff Ltd. All Rights Reserved. Hosted by

SourceForge Logo