org.yawlfoundation.yawl.util

Class YPredicateParser

java.lang.Object

org.yawlfoundation.yawl.util.YPredicateParser

Direct Known Subclasses:

DynTextParser, LogPredicateParser, YLogPredicateDecompositionParser, YLogPredicateParameterParser, YLogPredicateWorkItemParser, YNetElementDocoParser

public class YPredicateParser
extends java.lang.Object

Parses strings, replacing substrings within of the form ${expression} with the result of the expression evaluation Author: Michael Adams Date: 02/04/2010 Known subclasses: logging.YLogPredicateDecompositionParser, logging.YLogPredicateParameterParser, logging.YLogPredicateWorkItemParser, resourcing.util.LogPredicateParser, resourcing.jsf.dynform.DynTextParser Subclasses should override the 'valueOf' method to handle their own pre-parsing.

Constructor Summary

Constructors

Constructor and Description
YPredicateParser()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	dateTimeString(long time) Converts a time value to a full date & time string
protected java.lang.String	evaluateQuery(java.lang.String s, Element data) Evaluates an XQuery embedded within a delimited expression
protected java.lang.String	evaluateXQuery(java.lang.String s, Document dataDoc)
protected java.lang.String	evaluateXQuery(java.lang.String s, Element data) Evaluates an XQuery
protected java.lang.String	getAttributeValue(java.util.Map<java.lang.String,java.lang.String> map, java.lang.String s) Extracts a key from the delimited expression passed, then seeks the value corresponding to that key from the map passed
protected java.lang.String	namesToCSV(java.util.Set<java.lang.String> names) Transforms a Set of Strings into a string of comma separated values
java.lang.String	parse(java.lang.String s) Parses a string, replacing substrings within of the form ${expression} with the result of the expression evaluation
protected java.lang.String	stripDelimiters(java.lang.String s) removes the surrounding ${...} from a String
protected java.lang.String	valueOf(java.lang.String s) Evaluates an expression and returns the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

YPredicateParser

public YPredicateParser()

Method Detail

parse

public java.lang.String parse(java.lang.String s)

Parses a string, replacing substrings within of the form ${expression} with the result of the expression evaluation

Parameters:

s - the string to parse

Returns:

s, with any embedded expressions replaced with their evaluations

valueOf

protected java.lang.String valueOf(java.lang.String s)

Evaluates an expression and returns the result. Subclasses should override this class to do their own expression evaluations before calling this version for any general expression evaluations.

Parameters:

s - the string representing the expression, of the form ${expression}

Returns:

the result of the expression evaluation, or the unchanged string if the expression is unrecognised

dateTimeString

protected java.lang.String dateTimeString(long time)

Converts a time value to a full date & time string

Parameters:

time - the time value

Returns:

a string representing the date & time value

getAttributeValue

protected java.lang.String getAttributeValue(java.util.Map<java.lang.String,java.lang.String> map,
                                             java.lang.String s)

Extracts a key from the delimited expression passed, then seeks the value corresponding to that key from the map passed

Parameters:

map - a map of String pairs

s - a string representing an expression, of the form ${expression:key}, containing the key

Returns:

the corresponding key value, or null if the map is null or the map does not contain the key

namesToCSV

protected java.lang.String namesToCSV(java.util.Set<java.lang.String> names)

Transforms a Set of Strings into a string of comma separated values

Parameters:

names - the Set of Strings to transform

Returns:

a string containing each of the Strings in the Set, spearated by a comma, or "Nil" if there are no Strings in the Set

evaluateQuery

protected java.lang.String evaluateQuery(java.lang.String s,
                                         Element data)

Evaluates an XQuery embedded within a delimited expression

Parameters:

s - the delimited expression, either of the form ${query} or ${expression:query}

data - XML'd data that may be referenced by the expression. May be null if the expression doesn't reference any data

Returns:

the result of the evaluation, or "__evaluation_error__" if there's a problem evaluating the expression

evaluateXQuery

protected java.lang.String evaluateXQuery(java.lang.String s,
                                          Element data)

Evaluates an XQuery

Parameters:

s - the query expression

data - XML'd data that may be referenced by the expression. May be null if the expression doesn't reference any data

Returns:

the result of the evaluation, or "__evaluation_error__" if there's a problem evaluating the expression

evaluateXQuery

protected java.lang.String evaluateXQuery(java.lang.String s,
                                          Document dataDoc)

stripDelimiters

protected java.lang.String stripDelimiters(java.lang.String s)

removes the surrounding ${...} from a String

Parameters:

s - the delimited String

Returns:

the inner contents of the String with the delimiters removed