com.eibus.xml.xpath

Class XPathResult

java.lang.Object

com.eibus.xml.xpath.XPathResult

public class XPathResult
extends java.lang.Object

This class represents the generic result that is obtained after an XPath expression is evaluated.The result of the expression can be a number,string,boolean or a Nodeset.This class holds the results and provides means to retrieve them appropriately. E.g
Document doc = new Document();
int iXml = doc.load("Book.xml");
XPath oXPath = new XPath("/book/chapter[1]/lesson[1]/child::text()");

//Return as a generic XPathResult.
XPathResult oXPathResult = oXPath.evaluate(iXml);


Field Summary

Fields

Modifier and Type	Field and Description
static int	XPATH_BOOLEAN XPATH_BOOLEAN represents that the XPathResult is of type boolean.
static int	XPATH_CUSTOM XPATH_CUSTOM represents that the XPathResult is user defined.
static int	XPATH_INVALID XPATH_INVALID represents that the XPathResult is of invalid type.
static int	XPATH_NaN XPATH_NaN represents that the XPathResult is of NaN type.
static int	XPATH_NODESET XPATH_NODESET represents that the XPathResult is of type NodeSet.
static int	XPATH_NUMBER XPATH_NUMBER represents that the XPathResult is of type 'number' - double.
static int	XPATH_STRING XPATH_STRING represents that the XPathResult is of type String.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XPathResult() Private constructor.
protected	XPathResult(long iHandle)
protected	XPathResult(long iHandle, int type)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	delete() This method deletes the XPathResult Object.
protected void	finalize()
boolean	getBooleanResult() If the type is XPATH_BOOLEAN the result is returned as a boolean.
java.lang.Object	getCustomResultObject() If the type is XPATH_CUSTOM the result is returned as an Object.
static XPathResult	getInstance(boolean b) Returns a new XPathResult object with the result type XPATH_BOOLEAN .
static XPathResult	getInstance(double d) Returns a new XPathResult object with the result type XPATH_NUMBER
static XPathResult	getInstance(NodeSet oNSet) Returns a new XPathResult object with the result type XPATH_NODESET
static XPathResult	getInstance(java.lang.Object o) Returns a new XPathResult object with the result type XPATH_CUSTOm
static XPathResult	getInstance(java.lang.String str) Returns a new XPathResult object with the result type XPATH_STRING
double	getNumberResult() If the type is XPATH_NUMBER the result is returned as a double.
java.lang.String	getStringResult() If the type is XPATH_STRING the result is returned as a String.
int	getType() Returns the type of result this object represents.
NodeSet	removeNodeSetFromResult() If the type is XPATH_NODESET the result is returned as a NodeSet.
void	setResult(boolean b) It sets the type of XPathResult object to XPATH_BOOLEAN.
void	setResult(double d) It sets the type of XPathResult object to XPATH_NUMBER.
void	setResult(NodeSet n) It sets the type of XPathResult object to XPATH_NODESET.
void	setResult(java.lang.Object b) It sets the type of XPathResult object to XPATH_CUSTOM.
void	setResult(java.lang.String s) It sets the type of XPathResult object to XPATH_STRING.
java.lang.String	toString() This function converts the native result handle to string.

Methods inherited from class java.lang.Object

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

Field Detail

XPATH_BOOLEAN

public static final int XPATH_BOOLEAN

XPATH_BOOLEAN represents that the XPathResult is of type boolean.

See Also:

Constant Field Values

XPATH_NODESET

public static final int XPATH_NODESET

XPATH_NODESET represents that the XPathResult is of type NodeSet.

See Also:

Constant Field Values

XPATH_STRING

public static final int XPATH_STRING

XPATH_STRING represents that the XPathResult is of type String.

See Also:

Constant Field Values

XPATH_NUMBER

public static final int XPATH_NUMBER

XPATH_NUMBER represents that the XPathResult is of type 'number' - double.

See Also:

Constant Field Values

XPATH_CUSTOM

public static final int XPATH_CUSTOM

XPATH_CUSTOM represents that the XPathResult is user defined.

See Also:

Constant Field Values

XPATH_NaN

public static final int XPATH_NaN

XPATH_NaN represents that the XPathResult is of NaN type.

See Also:

Constant Field Values

XPATH_INVALID

public static final int XPATH_INVALID

XPATH_INVALID represents that the XPathResult is of invalid type.

See Also:

Constant Field Values

Constructor Detail

XPathResult

protected XPathResult()

Private constructor. To prevent naive users. Use getInstance

XPathResult

protected XPathResult(long iHandle)

XPathResult

protected XPathResult(long iHandle,
           int type)

Method Detail

getInstance

public static XPathResult getInstance(java.lang.String str)

Returns a new XPathResult object with the result type XPATH_STRING

Parameters:

str - The result input string.

Returns:

XPathResult Instance

Example:

 <code>
 XPathResult res = XPathResult.getInstance("BPM");
 assertEquals(XPathResult.XPATH_STRING, res.getType());
 </code>
 

getInstance

public static XPathResult getInstance(double d)

Returns a new XPathResult object with the result type XPATH_NUMBER

Parameters:

d - The result input number.

Returns:

XPathResult Instance

Example:

 <code>
 XPathResult res = XPathResult.getInstance(10.5);
 assertEquals(XPathResult.XPATH_NUMBER, res.getType());
 </code>
 

getInstance

public static XPathResult getInstance(boolean b)

Returns a new XPathResult object with the result type XPATH_BOOLEAN .

Parameters:

b - The boolean input result.

Returns:

XPathResult Instance

Example:

 <code>
 XPathResult res = XPathResult.getInstance(true);
 assertEquals(XPathResult.XPATH_BOOLEAN, res.getType());
 </code>
 

getInstance

public static XPathResult getInstance(NodeSet oNSet)

Returns a new XPathResult object with the result type XPATH_NODESET

Parameters:

oNSet - The NodeSet object as result input.

Returns:

XPathResult Instance

Example:

 <code>
 Document oDocument = new Document();
 int iNode;
 try {
        iNode = oDocument.load("<root><table>text</table><chair/></root>"
                        .getBytes());
        XPath oXPath0 = XPath.getXPathInstance("//root/table");
        XPathResult res = oXPath0.evaluate(iNode);
        NodeSet nSet = res.removeNodeSetFromResult();
        XPathResult res2 = XPathResult.getInstance(nSet);
        assertEquals(XPathResult.XPATH_NODESET, res2.getType());
 } catch (XMLException e) {
        e.printStackTrace();
 }
 </code>
 

getInstance

public static XPathResult getInstance(java.lang.Object o)

Returns a new XPathResult object with the result type XPATH_CUSTOm

Parameters:

o - The object as result input.

Returns:

XPathResult Instance

Example:

 <code>
 String str = "abc";
 XPathResult res = XPathResult.getInstance((Object) str);
 assertEquals(XPathResult.XPATH_CUSTOM, res.getType());
 </code>
 

getType

public int getType()

Returns the type of result this object represents. Range is { XPATH_NUMBER,XPATH_NODESET,XPATH_BOOLEAN,XPATH_STRING .

Returns:

The result type.

Example:

 <code>
 String str = "abc";
 XPathResult res = XPathResult.getInstance((Object) str);
 assertEquals(XPathResult.XPATH_CUSTOM, res.getType());
 </code>
 

delete

protected void delete()

This method deletes the XPathResult Object.

Example:

 <code>
 String str = "abc";
 XPathResult res = XPathResult.getInstance((Object) str);
 res.delete();
 </code>
 

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getStringResult

public java.lang.String getStringResult()

If the type is XPATH_STRING the result is returned as a String. Else InvalidFormatException is thrown

Returns:

The resultant String

Example:

 <code>
 Document oDocument = new Document();
 int iNode;
 try {
        String str = "\"abc   \"";
        iNode = oDocument.load("<root><table>text</table><chair/></root>"
                        .getBytes());//Trims the leading and trailing space from string. Also replaces consecutive occurrences of white space with a single space.
        XPath oXPath0 = XPath.getXPathInstance("normalize-space(" + str + ")");
        XPathResult res = oXPath0.evaluate(iNode);
        assertEquals(XPathResult.XPATH_STRING, res.getType());
        assertEquals("abc", res.getStringResult());
 } catch (XMLException e) {
        e.printStackTrace();
 }
 </code>
 

getBooleanResult

public boolean getBooleanResult()

If the type is XPATH_BOOLEAN the result is returned as a boolean. Else InvalidFormatException is thrown

Returns:

The boolean result.

Example:

 <code>
 Document oDocument = new Document();
 int iNode;
 try {
        String str1 = "\"landscape\"";
        String str2 = "\"sky\"";
        iNode = oDocument.load("<root><table>text</table><chair/></root>"
                        .getBytes());
        XPath oXPath0 = XPath.getXPathInstance("contains(" + str1 + "," + str2
                        + ")");//Returns true if the first string contains the second string.
        XPathResult res = oXPath0.evaluate(iNode);
        assertEquals(false, res.getBooleanResult());
 } catch (XMLException e) {
        e.printStackTrace();
 }
 
 </code>
 

getNumberResult

public double getNumberResult()

If the type is XPATH_NUMBER the result is returned as a double. Else InvalidFormatException is thrown

Returns:

The 'number' result as double.

Example:

 <code>
 Document oDocument = new Document();
 int iNode;
 try {
        iNode = oDocument.load("<root><table>text</table><chair/></root>"
                        .getBytes());
        XPath oXPath0 = XPath.getXPathInstance("5+3");//Returns true if the first string contains the second string.
        XPathResult res = oXPath0.evaluate(iNode);
        assertEquals(8.0, res.getNumberResult());
 } catch (XMLException e) {
        e.printStackTrace();
 }
 </code>
 

removeNodeSetFromResult

public NodeSet removeNodeSetFromResult()

If the type is XPATH_NODESET the result is returned as a NodeSet. Else InvalidFormatException is thrown. The native XPathResult is cleared.

Returns:

The resultant NodeSet object.

Example:

 <code>
         Document oDocument = new Document();
        int iNode;
        try {
                iNode = oDocument.load("<root><table>text</table><chair/></root>".getBytes());
                XPath oXPath0 = XPath.getXPathInstance("//root/table");//Returns true if the first string contains the second string.
                XPathResult res = oXPath0.evaluate(iNode);
                NodeSet nSet = res.removeNodeSetFromResult();
        }
                long iRes = nSet.next();
                assertEquals("table",ResultNode.getName(iRes));
        } catch (XMLException e) {
                e.printStackTrace();
 </code>
 

getCustomResultObject

public java.lang.Object getCustomResultObject()

If the type is XPATH_CUSTOM the result is returned as an Object. Else InvalidFormatException is thrown

Returns:

The resultant NodeSet object.

Example:

 <code>
 XPathResult result = XPathResult.getInstance((Object)"xml");
 assertEquals(XPathResult.XPATH_CUSTOM, result.getType());
 Object object = result.getCustomResultObject();                        
  
 </code>
 

setResult

public void setResult(double d)

It sets the type of XPathResult object to XPATH_NUMBER.

Parameters:

d - The double value to be set.

Example:

 <code>
 XPathResult res = XPathResult.getInstance(10.5);
 assertEquals(XPathResult.XPATH_NUMBER, res.getType());
 res.setResult(true);
 assertEquals(XPathResult.XPATH_BOOLEAN, res.getType());
 
 </code>
 

setResult

public void setResult(NodeSet n)

It sets the type of XPathResult object to XPATH_NODESET.

Parameters:

n - The nodeSet to be set.

Example:

 <code>
 try {
        iNode = oDocument.load("<root><table>text</table><chair/></root>"
                        .getBytes());
        XPath oXPath0 = XPath.getXPathInstance("//root/table");
        XPathResult res = oXPath0.evaluate(iNode);
        NodeSet nSet = res.removeNodeSetFromResult();
        XPathResult res2 = XPathResult.getInstance(10.5);
        assertEquals(XPathResult.XPATH_NUMBER, res2.getType());
        res2.setResult(nSet);
        assertEquals(XPathResult.XPATH_NODESET, res2.getType());
 } catch (XMLException e) {
        e.printStackTrace();
 }
 </code>
 

setResult

public void setResult(java.lang.String s)

It sets the type of XPathResult object to XPATH_STRING.

Parameters:

s - The string value to be set.

Example:

 <code>
 XPathResult res = XPathResult.getInstance(true);
 assertEquals(XPathResult.XPATH_BOOLEAN, res.getType());
 res.setResult("Cordys BCP");
 assertEquals(XPathResult.XPATH_STRING, res.getType());
 </code>
 

setResult

public void setResult(boolean b)

It sets the type of XPathResult object to XPATH_BOOLEAN.

Parameters:

b - The boolean value to be set.

Example:

 <code>
 XPathResult res = XPathResult.getInstance(10.5);
 assertEquals(XPathResult.XPATH_NUMBER, res.getType());
 res.setResult(true);
 assertEquals(XPathResult.XPATH_BOOLEAN, res.getType());
 </code>
 

setResult

public void setResult(java.lang.Object b)

It sets the type of XPathResult object to XPATH_CUSTOM.

Parameters:

b - The Object to be set.

Example:

 <code>
 String str = "xml";
 XPathResult res = XPathResult.getInstance(10.5);
 assertEquals(XPathResult.XPATH_NUMBER, res.getType());
 res.setResult((Object) str);
 assertEquals(XPathResult.XPATH_CUSTOM, res.getType());
 
 </code>
 

toString

public java.lang.String toString()

This function converts the native result handle to string.

Overrides:

toString in class java.lang.Object