org.cip4.lib.xjdf.xml.internal

Class XPathNavigatorBase

java.lang.Object

org.cip4.lib.xjdf.xml.internal.XPathNavigatorBase

Direct Known Subclasses:

XJdfNavigator

public class XPathNavigatorBase
extends Object

Navigator class which simplify XPath handling using XML Documents.

Author:

s.meissner

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	xmlDocument
protected XPath	xPath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XPathNavigatorBase(byte[] xmlBytes) Custom constructor.
protected	XPathNavigatorBase(InputStream xmlStream) Custom constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Object	evaluate(String xPath, QName qname) Evaluate an XPath expression on XML Document.
byte[]	getXmlBytes() Return the XML Document as Byte Array.
InputStream	getXmlStream() Return the XML Document as input stream.
String	readAttribute(String xPath) Read attribute from XML Document using XPath.
Object	readAttribute(String xPath, Class xJdfType) Read attribute from XML Document using XPath and convert to JDF Datatype.
void	updateAttribute(String xPath, AbstractXJdfType value) Update attribute in XML Document.
void	updateAttribute(String xPath, String value) Update attribute in XML Document.

Methods inherited from class java.lang.Object

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

Field Detail

xPath

protected final XPath xPath

xmlDocument

protected final Document xmlDocument

Constructor Detail

XPathNavigatorBase

protected XPathNavigatorBase(byte[] xmlBytes)
                      throws Exception

Custom constructor. Accepting a XML Document as Byte Array for initializing.

Parameters:

xmlBytes -

Throws:

Exception

XPathNavigatorBase

protected XPathNavigatorBase(InputStream xmlStream)
                      throws Exception

Custom constructor. Accepting a XML Document as Stream for initializing.

Throws:

Exception

Method Detail

readAttribute

public String readAttribute(String xPath)
                     throws XPathExpressionException

Read attribute from XML Document using XPath.

Parameters:

xPath - XPath expression of attribute to read.

Returns:

Value of attribute as String.

Throws:

XPathExpressionException - Is being thrown in case an exception occurs.

readAttribute

public Object readAttribute(String xPath,
                   Class xJdfType)
                     throws XPathExpressionException,
                            NoSuchMethodException,
                            SecurityException,
                            InstantiationException,
                            IllegalAccessException,
                            IllegalArgumentException,
                            InvocationTargetException

Read attribute from XML Document using XPath and convert to JDF Datatype.

Parameters:

xPath - XPath expression to evaluate.

xJdfType - Target JDF Data Type of attribute.

Returns:

Value as JDF Data Type.

Throws:

XPathExpressionException

SecurityException

NoSuchMethodException

InvocationTargetException

IllegalArgumentException

IllegalAccessException

InstantiationException

evaluate

public Object evaluate(String xPath,
              QName qname)
                throws XPathExpressionException

Evaluate an XPath expression on XML Document.

Parameters:

xPath - XPath expression to execute to.

qname - QName as javax.xml.xpath.XPathConstants

Returns:

Generic result.

Throws:

XPathExpressionException - Is thrown in case an XPath Exception occurs.

updateAttribute

public void updateAttribute(String xPath,
                   AbstractXJdfType value)
                     throws Exception

Update attribute in XML Document.

Parameters:

xPath - XPath expression of attribute to read.

Throws:

Exception - Is being thrown in case an exception occurs.

updateAttribute

public void updateAttribute(String xPath,
                   String value)
                     throws Exception

Update attribute in XML Document.

Parameters:

xPath - XPath expression of attribute to read.

Throws:

Exception - Is being thrown in case an exception occurs.

getXmlStream

public InputStream getXmlStream()
                         throws Exception

Return the XML Document as input stream.

Returns:

XML document as input stream.

Throws:

Exception

getXmlBytes

public byte[] getXmlBytes()
                   throws Exception

Return the XML Document as Byte Array.

Returns:

XML Document as Byte Array.

Throws:

Exception - Is thrown in case an Exception occurs.