Package adams.core.base

Class XPathExpression

java.lang.Object

adams.core.base.BaseObject

adams.core.base.AbstractBaseString

adams.core.base.XPathExpression

All Implemented Interfaces:

CloneHandler<BaseObject>, HelpProvider, Serializable, Comparable

public class XPathExpression
extends AbstractBaseString
implements HelpProvider

Encapsulates an XPath expression.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.base.BaseObject

m_Internal, m_Properties, SUFFIX_DISPLAY, SUFFIX_VALUE

Constructor Summary

Constructors

Constructor	Description
XPathExpression()	Initializes the string with length 0.
XPathExpression(String s)	Initializes the object with the string to parse.

Method Summary

Modifier and Type	Method	Description
String	getHelpDescription()	Returns a long help description, e.g., used in tiptexts.
String	getHelpIcon()	Returns the name of a help icon, e.g., used for buttons.
String	getHelpTitle()	Returns a short title for the help, e.g., used for buttons.
String	getHelpURL()	Returns a URL with additional information.
String	getTipText()	Returns a tool tip for the GUI editor (ignored if null is returned).

Methods inherited from class adams.core.base.AbstractBaseString

convert, getValue, initialize, isEmpty, isValid, length, setValue, stringValue

Methods inherited from class adams.core.base.BaseObject

compareTo, equals, getClone, getInternal, getTemplates, getUnicode, hasFavoritesSupport, hashCode, isValidUnicode, newInstance, setUnicode, toObjectArray, toObjectArray, toString, toStringArray, toStringList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPathExpression

public XPathExpression()

Initializes the string with length 0.

XPathExpression

public XPathExpression(String s)

Initializes the object with the string to parse.

Parameters:

s - the string to parse

Method Detail

getTipText

public String getTipText()

Returns a tool tip for the GUI editor (ignored if null is returned).

Specified by:

getTipText in class AbstractBaseString

Returns:

the tool tip

getHelpURL

public String getHelpURL()

Returns a URL with additional information.

Specified by:

getHelpURL in interface HelpProvider

Returns:

the URL, null if not available

getHelpDescription

public String getHelpDescription()

Returns a long help description, e.g., used in tiptexts.

Specified by:

getHelpDescription in interface HelpProvider

Returns:

the help text, null if not available

getHelpTitle

public String getHelpTitle()

Returns a short title for the help, e.g., used for buttons.

Specified by:

getHelpTitle in interface HelpProvider

Returns:

the short title, null if not available

getHelpIcon

public String getHelpIcon()

Returns the name of a help icon, e.g., used for buttons.

Specified by:

getHelpIcon in interface HelpProvider

Returns:

the icon name, null if not available