activityconfig

Class ParsedStmt

java.lang.Object

activityconfig.ParsedStmt

public class ParsedStmt
extends Object

Allow for uniform statement anchor parsing, using the

?anchor

and

{anchor}

anchoring conventions. This type also includes all of the properties from the enclosed StmtDef, in addition to a couple of helpers. It should allow programmers to project this type directly from an existing StmtDef as a substitute.

Constructor Summary

Constructors

Constructor and Description
ParsedStmt(StmtDef stmtDef) Construct a new ParsedStatement from the provided stmtDef and anchor token.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getBindings()
Set<String>	getExtraBindings() The list of binding names returned by this method does not constitute an error.
Set<String>	getMissingBindings() Returns a list of binding names which were referenced in either
String	getName()
Map<String,String>	getParams()
String	getPositionalStatement(String anchorToken) Return the statement that can be used as-is by any driver specific version.
Map<String,String>	getSpecificBindings() Return a map of bindings which were referenced in the statement.
String	getStmt()
Map<String,String>	getTags()
boolean	hasError()
ParsedStmt	orError()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParsedStmt

public ParsedStmt(StmtDef stmtDef)

Construct a new ParsedStatement from the provided stmtDef and anchor token.

Parameters:

stmtDef - An existing statement def as read from the YAML API.

Method Detail

orError

public ParsedStmt orError()

toString

public String toString()

Overrides:

toString in class Object

hasError

public boolean hasError()

Returns:

true if the parsed statement is not usable.

getExtraBindings

public Set<String> getExtraBindings()

The list of binding names returned by this method does not constitute an error. They may be used for for informational purposes in error handlers, for example.

Returns:

a set of bindings names which were provided to this parsed statement, but which were not referenced in either

{anchor}

or

?anchor

form.

getMissingBindings

public Set<String> getMissingBindings()

Returns a list of binding names which were referenced in either

{anchor}

or

?anchor

form, but which were not present in the provided bindings map. If any binding names are present in the returned set, then this binding will not be usable.

Returns:

A list of binding names which were referenced but not defined*

getSpecificBindings

public Map<String,String> getSpecificBindings()

Return a map of bindings which were referenced in the statement. This is an easy way to get the list of effective bindings for a statement for diagnostic purposes without including a potentially long list of library bindings.

Returns:

a bindings map of referenced bindings in the statement

getPositionalStatement

public String getPositionalStatement(String anchorToken)

Return the statement that can be used as-is by any driver specific version. This uses the anchor token as provided to yield a version of the statement which contains positional anchors, but no named bindings.

Parameters:

anchorToken - The token which is to be used as a positional place holder

Returns:

A driver or usage-specific format of the statement, with anchors

getName

public String getName()

Returns:

the statement name from the enclosed StmtDef

getStmt

public String getStmt()

Returns:

the raw statement from the enclosed StmtDef

getTags

public Map<String,String> getTags()

Returns:

the tags from the enclosed StmtDef

getBindings

public Map<String,String> getBindings()

Returns:

the bindings from the enclosed StmtDef

getParams

public Map<String,String> getParams()

Returns:

the params from the enclosed StmtDef