Package com.inductiveautomation.ignition.common.expressions.parsing

Class StringParser

java.lang.Object

com.inductiveautomation.ignition.common.expressions.parsing.StringParser

All Implemented Interfaces:

Parser

public class StringParser
extends Object
implements Parser

A parser that handles string interpolation, supporting literal text mixed with bound paths (e.g., "{path/to/tag}").

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StringParser.EscapeStrategy
protected static class	StringParser.StringOrPath

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOSE_DELIM
static final String	ESCAPE
static final String	OPEN_DELIM

Constructor Summary

Constructors

Modifier	Constructor	Description
	StringParser()
protected	StringParser(Class<? extends AbstractExpression> exprType)	This constructor specifies what type of expression should be created.

Method Summary

Modifier and Type	Method	Description
protected void	addPart(List<StringParser.StringOrPath> parts, StringParser.StringOrPath newPart)
StringParser.EscapeStrategy	getAllowsReferenceEscape()
static StringParser	newQueryParser()	Returns a parser that expects to parse sql queries for references
static StringParser	newStandardParser_Localized()	Returns a parser who creates expressions that simply toString sub-expressions, adjusting the values for the locale.
static StringParser	newStandardParser_NonLocalized()	Returns a parser who creates an expression that is the toString of all of the sub-expressions, but with no consideration of the locale.
Expression	parse(String expr, ExpressionParseContext binder)	Parse the given string into an Expression.
protected StringParser.StringOrPath[]	parseQueryWithBoundPaths(String query)
protected StringParser.StringOrPath[]	parseQueryWithBoundPathsEscapedCharacters(String query)
protected static StringParser.StringOrPath[]	parseQueryWithBoundPathsNoEscape(String query)
protected StringParser.StringOrPath[]	parseQueryWithEscapedBoundPaths(String query)	Chops up a query, returning the string segments and path segments separately
void	preventToStringSingleExpression(boolean prevent)	If set to true and the parsed expression only contains one expression.
void	setAllowsReferenceEscape(boolean escapeReference)	If true, allows item reference syntax, such as "{blah}" to be escaped with "\", to avoid expansion.
void	setEscapeStrategy(StringParser.EscapeStrategy strategy)

Methods inherited from class java.lang.Object

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

Field Details

ESCAPE

public static final String ESCAPE

See Also:

• Constant Field Values

OPEN_DELIM

public static final String OPEN_DELIM

See Also:

• Constant Field Values

CLOSE_DELIM

public static final String CLOSE_DELIM

See Also:

• Constant Field Values

Constructor Details

StringParser

public StringParser()

StringParser

protected StringParser(Class<? extends AbstractExpression> exprType)

This constructor specifies what type of expression should be created. Different expressions will behave differently.

Method Details

newStandardParser_Localized

public static StringParser newStandardParser_Localized()

Returns a parser who creates expressions that simply toString sub-expressions, adjusting the values for the locale.

newStandardParser_NonLocalized

public static StringParser newStandardParser_NonLocalized()

Returns a parser who creates an expression that is the toString of all of the sub-expressions, but with no consideration of the locale.

newQueryParser

public static StringParser newQueryParser()

Returns a parser that expects to parse sql queries for references

setAllowsReferenceEscape

public void setAllowsReferenceEscape(boolean escapeReference)

If true, allows item reference syntax, such as "{blah}" to be escaped with "\", to avoid expansion. False, uses StringParser.EscapeStrategy.NONE True, uses StringParser.EscapeStrategy.REFERENCE

setEscapeStrategy

public void setEscapeStrategy(StringParser.EscapeStrategy strategy)

getAllowsReferenceEscape

public StringParser.EscapeStrategy getAllowsReferenceEscape()

preventToStringSingleExpression

public void preventToStringSingleExpression(boolean prevent)

If set to true and the parsed expression only contains one expression. The direct result of that expression will not be wrapped with a toString expression.

parse

public Expression parse(String expr,
 ExpressionParseContext binder)
                 throws Exception

Description copied from interface: Parser

Parse the given string into an Expression.

Specified by:

parse in interface Parser

Parameters:

expr - the expression string to parse

binder - the ExpressionParseContext to use during parsing

Returns:

the parsed Expression

Throws:

Exception - if the expression cannot be parsed

addPart

protected void addPart(List<StringParser.StringOrPath> parts,
 StringParser.StringOrPath newPart)

parseQueryWithBoundPaths

protected StringParser.StringOrPath[] parseQueryWithBoundPaths(String query)
                                                        throws Exception

Throws:

Exception

parseQueryWithBoundPathsEscapedCharacters

protected StringParser.StringOrPath[] parseQueryWithBoundPathsEscapedCharacters(String query)

parseQueryWithEscapedBoundPaths

protected StringParser.StringOrPath[] parseQueryWithEscapedBoundPaths(String query)
                                                               throws Exception

Chops up a query, returning the string segments and path segments separately

Throws:

Exception

parseQueryWithBoundPathsNoEscape

protected static StringParser.StringOrPath[] parseQueryWithBoundPathsNoEscape(String query)
                                                                       throws Exception

Throws:

Exception