Package adams.core.base

Class JsonPathExpression

java.lang.Object

adams.core.base.BaseObject

adams.core.base.AbstractBaseString

adams.core.base.JsonPathExpression

All Implemented Interfaces:

CloneHandler<BaseObject>, HelpProvider, Serializable, Comparable

public class JsonPathExpression
extends AbstractBaseString
implements HelpProvider

Encapsulates a JSON Path expression.

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
JsonPathExpression()	Initializes the string with length 0.
JsonPathExpression(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).
boolean	isIndefinite()	Returns whether the path expression is an indefinite one, i.e., it will return a list rather than a single item.
boolean	isSimpleKey()	Returns whether the path expression is just a simple key rather than a path.
boolean	isValid(String value)	Checks whether the string value is a valid presentation for this class.
com.jayway.jsonpath.JsonPath	toJsonPath()	Returns the JsonPath object, if possible.

Methods inherited from class adams.core.base.AbstractBaseString

convert, getValue, initialize, isEmpty, 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

JsonPathExpression

public JsonPathExpression()

Initializes the string with length 0.

JsonPathExpression

public JsonPathExpression(String s)

Initializes the object with the string to parse.

Parameters:

s - the string to parse

Method Detail

isValid

public boolean isValid(String value)

Checks whether the string value is a valid presentation for this class.

Overrides:

isValid in class AbstractBaseString

Parameters:

value - the string value to check

Returns:

always true

isSimpleKey

public boolean isSimpleKey()

Returns whether the path expression is just a simple key rather than a path.

Returns:

true if just a simple key and not a path

isIndefinite

public boolean isIndefinite()

Returns whether the path expression is an indefinite one, i.e., it will return a list rather than a single item. Indefinite if:

• .. - a deep scan operator
• ?(expression) - an expression
• [number, number (, number)] - multiple array indexes

Returns:

true if indefinite

toJsonPath

public com.jayway.jsonpath.JsonPath toJsonPath()

Returns the JsonPath object, if possible.

Returns:

the

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