edu.ucsb.cs.jicos.services.external
Interface ExternalData

All Known Implementing Classes:

ExternalDataList, XmlDocument

public interface ExternalData

Method Summary

java.lang.String[]	getArray(java.lang.String xpathQuery) Get an individual value from the document.
java.lang.String	getValue(java.lang.String xpathQuery) Get an individual value from the document.
ExternalData	removeWrapper() Get the data out of the (optional) wrapper.

Method Detail

getArray

java.lang.String[] getArray(java.lang.String xpathQuery)

Get an individual value from the document. This supports a very limited subset of the XPath queries. Right now, it only supports paths, leaves, and attributes. Although it will return an array of nodes IFF they are the leaf nodes.

SOME Known Limitations:

• All queries must begin with '/'.
• Any descendant (//) is not allowed.
• Relative child child::para[position()= n is not allowed.
• Wildcards are only allowed on leaf nodes (.../*)
• .../child::para and .../para are equivalent.

Parameters:

xpathQuery - An XPath query.

Returns:

An individual node.

getValue

java.lang.String getValue(java.lang.String xpathQuery)

Get an individual value from the document. This supports a very limited subset of the XPath queries. Right now, it only supports paths, leaves, and attributes. SOME Known Limitations:

• All queries must begin with '/'.
• Wildcards * and // are not allowed.

Selections:

• /path/to/node selects the value of node.
• /path/to/node/@attribute selects the value of the attribute of node.

Parameters:

xpathQuery - An XPath query.

Returns:

An individual string value.

removeWrapper

ExternalData removeWrapper()

Get the data out of the (optional) wrapper. This may return the same object.

Returns:

The data.