org.jaxen.javabean

クラス DocumentNavigator

java.lang.Object

org.jaxen.DefaultNavigator

org.jaxen.javabean.DocumentNavigator

すべての実装されたインタフェース:

Serializable, NamedAccessNavigator, Navigator

public class DocumentNavigator
extends DefaultNavigator
implements NamedAccessNavigator

Interface for navigating around a JavaBean object model.

This class is not intended for direct usage, but is used by the Jaxen engine during evaluation.

作成者:

bob mcwhirter

関連項目:

XPath, 直列化された形式

コンストラクタの概要

コンストラクタ

コンストラクタと説明
DocumentNavigator()

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
Iterator	getAttributeAxisIterator(Object contextNode) Throws UnsupportedAxisException.
Iterator	getAttributeAxisIterator(Object contextNode, String localName, String namespacePrefix, String namespaceURI) Retrieves an Iterator over the attribute elements that match the supplied name.
String	getAttributeName(Object obj) Retrieve the local name of the given attribute node.
String	getAttributeNamespaceUri(Object obj) Retrieve the namespace URI of the given attribute node.
String	getAttributeQName(Object obj) Retrieve the qualified name of the given attribute node.
String	getAttributeStringValue(Object obj) Retrieve the string-value of an attribute node.
Iterator	getChildAxisIterator(Object contextNode) Throws UnsupportedAxisException
Iterator	getChildAxisIterator(Object contextNode, String localName, String namespacePrefix, String namespaceURI) Retrieves an Iterator over the child elements that match the supplied name.
String	getCommentStringValue(Object obj) Retrieve the string-value of a comment node.
Object	getDocument(String uri) Default implementation that always returns null.
Object	getDocumentNode(Object contextNode) Returns the document node that contains the given context node.
String	getElementName(Object obj) Retrieve the local name of the given element node.
String	getElementNamespaceUri(Object obj) Retrieve the namespace URI of the given element node.
String	getElementQName(Object obj) Retrieve the qualified name of the given element node.
String	getElementStringValue(Object obj) Retrieve the string-value of an element node.
static Navigator	getInstance() Retrieve the singleton instance of this DocumentNavigator.
Iterator	getNamespaceAxisIterator(Object contextNode) Throws UnsupportedAxisException.
String	getNamespacePrefix(Object obj) Retrieve the namespace prefix of a namespace node.
String	getNamespaceStringValue(Object obj) Retrieve the string-value of a namespace node.
short	getNodeType(Object node) Returns a number that identifies the type of node that the given object represents in this navigator.
Iterator	getParentAxisIterator(Object contextNode) Throws UnsupportedAxisException
Object	getParentNode(Object contextNode) Default inefficient implementation.
String	getProcessingInstructionData(Object obj) Retrieve the data of a processing-instruction.
String	getProcessingInstructionTarget(Object obj) Retrieve the target of a processing-instruction.
String	getTextStringValue(Object obj) Retrieve the string-value of a text node.
boolean	isAttribute(Object obj) Returns whether the given object is an attribute node.
boolean	isComment(Object obj) Returns whether the given object is a comment node.
boolean	isDocument(Object obj) Returns whether the given object is a document node.
boolean	isElement(Object obj) Returns whether the given object is an element node.
boolean	isNamespace(Object obj) Returns whether the given object is a namespace node.
boolean	isProcessingInstruction(Object obj) Returns whether the given object is a processing-instruction node.
boolean	isText(Object obj) Returns whether the given object is a text node.
protected String	javacase(String name)
XPath	parseXPath(String xpath) Returns a parsed form of the given XPath string, which will be suitable for queries on documents that use the same navigator as this one.
String	translateNamespacePrefixToUri(String prefix, Object context) Translate a namespace prefix to a namespace URI, possibly considering a particular element node.

クラスから継承されたメソッド org.jaxen.DefaultNavigator

getAncestorAxisIterator, getAncestorOrSelfAxisIterator, getDescendantAxisIterator, getDescendantOrSelfAxisIterator, getElementById, getFollowingAxisIterator, getFollowingSiblingAxisIterator, getPrecedingAxisIterator, getPrecedingSiblingAxisIterator, getSelfAxisIterator

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド org.jaxen.Navigator

getAncestorAxisIterator, getAncestorOrSelfAxisIterator, getDescendantAxisIterator, getDescendantOrSelfAxisIterator, getElementById, getFollowingAxisIterator, getFollowingSiblingAxisIterator, getPrecedingAxisIterator, getPrecedingSiblingAxisIterator, getSelfAxisIterator

コンストラクタの詳細

DocumentNavigator

public DocumentNavigator()

メソッドの詳細

getInstance

public static Navigator getInstance()

Retrieve the singleton instance of this DocumentNavigator.

isElement

public boolean isElement(Object obj)

インタフェースからコピーされた説明: Navigator

Returns whether the given object is an element node.

定義:

isElement インタフェース内 Navigator

パラメータ:

obj - the object to test

戻り値:

true if the object is an element node, else false

isComment

public boolean isComment(Object obj)

インタフェースからコピーされた説明: Navigator

Returns whether the given object is a comment node.

定義:

isComment インタフェース内 Navigator

パラメータ:

obj - the object to test

戻り値:

true if the object is a comment node, else false

isText

public boolean isText(Object obj)

インタフェースからコピーされた説明: Navigator

Returns whether the given object is a text node.

定義:

isText インタフェース内 Navigator

パラメータ:

obj - the object to test

戻り値:

true if the object is a text node, else false

isAttribute

public boolean isAttribute(Object obj)

インタフェースからコピーされた説明: Navigator

Returns whether the given object is an attribute node.

定義:

isAttribute インタフェース内 Navigator

パラメータ:

obj - the object to test

戻り値:

true if the object is an attribute node, else false

isProcessingInstruction

public boolean isProcessingInstruction(Object obj)

インタフェースからコピーされた説明: Navigator

Returns whether the given object is a processing-instruction node.

定義:

isProcessingInstruction インタフェース内 Navigator

パラメータ:

obj - the object to test

戻り値:

true if the object is a processing-instruction node, else false

isDocument

public boolean isDocument(Object obj)

インタフェースからコピーされた説明: Navigator

Returns whether the given object is a document node. A document node is the node that is selected by the XPath expression /.

定義:

isDocument インタフェース内 Navigator

パラメータ:

obj - the object to test

戻り値:

true if the object is a document node, else false

isNamespace

public boolean isNamespace(Object obj)

インタフェースからコピーされた説明: Navigator

Returns whether the given object is a namespace node.

定義:

isNamespace インタフェース内 Navigator

パラメータ:

obj - the object to test

戻り値:

true if the object is a namespace node, else false

getElementName

public String getElementName(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the local name of the given element node.

定義:

getElementName インタフェース内 Navigator

パラメータ:

obj - the context element node

戻り値:

the local name of the element node

getElementNamespaceUri

public String getElementNamespaceUri(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the namespace URI of the given element node.

定義:

getElementNamespaceUri インタフェース内 Navigator

パラメータ:

obj - the context element node

戻り値:

the namespace URI of the element node

getElementQName

public String getElementQName(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the qualified name of the given element node.

定義:

getElementQName インタフェース内 Navigator

パラメータ:

obj - the context element node

戻り値:

the qualified name of the element node

getAttributeName

public String getAttributeName(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the local name of the given attribute node.

定義:

getAttributeName インタフェース内 Navigator

パラメータ:

obj - the context attribute node

戻り値:

the local name of the attribute node

getAttributeNamespaceUri

public String getAttributeNamespaceUri(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the namespace URI of the given attribute node.

定義:

getAttributeNamespaceUri インタフェース内 Navigator

パラメータ:

obj - the context attribute node

戻り値:

the namespace URI of the attribute node

getAttributeQName

public String getAttributeQName(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the qualified name of the given attribute node.

定義:

getAttributeQName インタフェース内 Navigator

パラメータ:

obj - the context attribute node

戻り値:

the qualified name of the attribute node

getChildAxisIterator

public Iterator getChildAxisIterator(Object contextNode)

クラスからコピーされた説明: DefaultNavigator

Throws UnsupportedAxisException

定義:

getChildAxisIterator インタフェース内 Navigator

オーバーライド:

getChildAxisIterator クラス内 DefaultNavigator

パラメータ:

contextNode - the original context node

戻り値:

never returns

getChildAxisIterator

public Iterator getChildAxisIterator(Object contextNode,
                            String localName,
                            String namespacePrefix,
                            String namespaceURI)

Retrieves an Iterator over the child elements that match the supplied name.

定義:

getChildAxisIterator インタフェース内 NamedAccessNavigator

パラメータ:

contextNode - the origin context node

localName - the local name of the children to return, always present

namespacePrefix - the prefix of the namespace of the children to return

namespaceURI - the namespace URI of the children to return

戻り値:

an Iterator that traverses the named children, or null if none

getParentAxisIterator

public Iterator getParentAxisIterator(Object contextNode)

クラスからコピーされた説明: DefaultNavigator

Throws UnsupportedAxisException

定義:

getParentAxisIterator インタフェース内 Navigator

オーバーライド:

getParentAxisIterator クラス内 DefaultNavigator

パラメータ:

contextNode - the original context node

戻り値:

never returns

getAttributeAxisIterator

public Iterator getAttributeAxisIterator(Object contextNode)

クラスからコピーされた説明: DefaultNavigator

Throws UnsupportedAxisException. Subclasses that support the attribute axis must override this method.

定義:

getAttributeAxisIterator インタフェース内 Navigator

オーバーライド:

getAttributeAxisIterator クラス内 DefaultNavigator

パラメータ:

contextNode - the original context node

戻り値:

never returns

getAttributeAxisIterator

public Iterator getAttributeAxisIterator(Object contextNode,
                                String localName,
                                String namespacePrefix,
                                String namespaceURI)

Retrieves an Iterator over the attribute elements that match the supplied name.

定義:

getAttributeAxisIterator インタフェース内 NamedAccessNavigator

パラメータ:

contextNode - the origin context node

localName - the local name of the attributes to return, always present

namespacePrefix - the prefix of the namespace of the attributes to return

namespaceURI - the namespace URI of the attributes to return

戻り値:

an Iterator that traverses the named attributes, not null

getNamespaceAxisIterator

public Iterator getNamespaceAxisIterator(Object contextNode)

クラスからコピーされた説明: DefaultNavigator

Throws UnsupportedAxisException. Subclasses that support the namespace axis must override this method.

定義:

getNamespaceAxisIterator インタフェース内 Navigator

オーバーライド:

getNamespaceAxisIterator クラス内 DefaultNavigator

パラメータ:

contextNode - the original context node

戻り値:

never returns

getDocumentNode

public Object getDocumentNode(Object contextNode)

インタフェースからコピーされた説明: Navigator

Returns the document node that contains the given context node.

定義:

getDocumentNode インタフェース内 Navigator

オーバーライド:

getDocumentNode クラス内 DefaultNavigator

パラメータ:

contextNode - the context node

戻り値:

the document of the context node

関連項目:

Navigator.isDocument(Object)

getParentNode

public Object getParentNode(Object contextNode)

クラスからコピーされた説明: DefaultNavigator

Default inefficient implementation. Subclasses should override this method.

定義:

getParentNode インタフェース内 Navigator

オーバーライド:

getParentNode クラス内 DefaultNavigator

パラメータ:

contextNode - the node whose parent to return

戻り値:

the parent node

関連項目:

Navigator.isDocument(java.lang.Object), Navigator.isElement(java.lang.Object)

getTextStringValue

public String getTextStringValue(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the string-value of a text node. This must not be null and should not be the empty string. The XPath data model does not allow empty text nodes.

定義:

getTextStringValue インタフェース内 Navigator

パラメータ:

obj - the text node

戻り値:

the string-value of the node

getElementStringValue

public String getElementStringValue(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the string-value of an element node. This may be the empty string if the element is empty, but must not be null.

定義:

getElementStringValue インタフェース内 Navigator

パラメータ:

obj - the comment node.

戻り値:

the string-value of the node.

getAttributeStringValue

public String getAttributeStringValue(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the string-value of an attribute node. This should be the XML 1.0 normalized attribute value. This may be the empty string but must not be null.

定義:

getAttributeStringValue インタフェース内 Navigator

パラメータ:

obj - the attribute node

戻り値:

the string-value of the node

getNamespaceStringValue

public String getNamespaceStringValue(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the string-value of a namespace node. This is generally the namespace URI. This may be the empty string but must not be null.

定義:

getNamespaceStringValue インタフェース内 Navigator

パラメータ:

obj - the namespace node

戻り値:

the string-value of the node

getNamespacePrefix

public String getNamespacePrefix(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the namespace prefix of a namespace node.

定義:

getNamespacePrefix インタフェース内 Navigator

パラメータ:

obj - the namespace node

戻り値:

the prefix associated with the node

getCommentStringValue

public String getCommentStringValue(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the string-value of a comment node. This may be the empty string if the comment is empty, but must not be null.

定義:

getCommentStringValue インタフェース内 Navigator

パラメータ:

obj - the comment node

戻り値:

the string-value of the node

translateNamespacePrefixToUri

public String translateNamespacePrefixToUri(String prefix,
                                   Object context)

インタフェースからコピーされた説明: Navigator

Translate a namespace prefix to a namespace URI, possibly considering a particular element node.

Strictly speaking, prefix-to-URI translation should occur irrespective of any element in the document. This method is provided to allow a non-conforming ease-of-use enhancement.

定義:

translateNamespacePrefixToUri インタフェース内 Navigator

オーバーライド:

translateNamespacePrefixToUri クラス内 DefaultNavigator

パラメータ:

prefix - the prefix to translate

context - the element to consider during translation

戻り値:

the namespace URI associated with the prefix

関連項目:

NamespaceContext

getNodeType

public short getNodeType(Object node)

インタフェースからコピーされた説明: Navigator

Returns a number that identifies the type of node that the given object represents in this navigator.

定義:

getNodeType インタフェース内 Navigator

オーバーライド:

getNodeType クラス内 DefaultNavigator

パラメータ:

node - ????

戻り値:

????

関連項目:

Pattern

getDocument

public Object getDocument(String uri)
                   throws FunctionCallException

クラスからコピーされた説明: DefaultNavigator

Default implementation that always returns null. Override in subclass if the subclass can load documents.

定義:

getDocument インタフェース内 Navigator

オーバーライド:

getDocument クラス内 DefaultNavigator

パラメータ:

uri - the URL of the document to load

戻り値:

null

例外:

FunctionCallException - if an error occurs while loading the URL; e.g. an I/O error or the document is malformed

getProcessingInstructionTarget

public String getProcessingInstructionTarget(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the target of a processing-instruction.

定義:

getProcessingInstructionTarget インタフェース内 Navigator

オーバーライド:

getProcessingInstructionTarget クラス内 DefaultNavigator

パラメータ:

obj - the context processing-instruction node

戻り値:

the target of the processing-instruction node

getProcessingInstructionData

public String getProcessingInstructionData(Object obj)

インタフェースからコピーされた説明: Navigator

Retrieve the data of a processing-instruction.

定義:

getProcessingInstructionData インタフェース内 Navigator

オーバーライド:

getProcessingInstructionData クラス内 DefaultNavigator

パラメータ:

obj - the context processing-instruction node

戻り値:

the data of the processing-instruction node

parseXPath

public XPath parseXPath(String xpath)
                 throws SAXPathException

インタフェースからコピーされた説明: Navigator

Returns a parsed form of the given XPath string, which will be suitable for queries on documents that use the same navigator as this one.

定義:

parseXPath インタフェース内 Navigator

パラメータ:

xpath - the XPath expression

戻り値:

a new XPath expression object

例外:

SAXPathException - if the string is not a syntactically correct XPath expression

関連項目:

XPath

javacase

protected String javacase(String name)