water.rapids.ast.params

Class AstStr

java.lang.Object

water.Iced<T>

water.rapids.ast.AstRoot

water.rapids.ast.AstParameter

water.rapids.ast.params.AstStr

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

public class AstStr
extends AstParameter

A String. Execution is just to return the constant.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AstStr()
AstStr(java.lang.String str)

Method Summary

Modifier and Type	Method and Description
int[]	columns(java.lang.String[] names)
ValStr	exec(Env env) "Execute" this AST expression, and return the result.
java.lang.String	getStr()
java.lang.String	str() String representation of this Ast object in the Rapids language.
java.lang.String	toJavaString()

Methods inherited from class water.rapids.ast.AstParameter

description, example

Methods inherited from class water.rapids.ast.AstRoot

toString

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Constructor Detail

AstStr

public AstStr()

AstStr

public AstStr(java.lang.String str)

Method Detail

str

public java.lang.String str()

Description copied from class: AstRoot

String representation of this Ast object in the Rapids language. For AstPrimitives this is the name of the function; for AstParameters this is either the name of the variable, or the value of the numeric constant that the parameter represents. For more complicated constructs such as AstExec or AstFunction this method should return those objects as a Rapids string.

Specified by:

str in class AstRoot

exec

public ValStr exec(Env env)

Description copied from class: AstRoot

"Execute" this AST expression, and return the result. For different ASTs this may have different interpretation. For example, consider this Rapids expression:

    (mean frame True False)

It will be parsed into the following structure:

 AstExec() instance with
    _asts = [AstMean() singleton instance,
             new AstId(frame),
             AstConst.TRUE,
             AstConst.FALSE]
 

Execution of AstExec will execute its first argument, _asts[0], verify that it produces a function (ValFun), then call AstPrimitive.apply(Env, Env.StackHelp, AstRoot[]) on that function passing down the list of _asts arguments.

The AstMean class will in turn execute all its arguments, where execution of AstId fetches the referred symbol from the environment, and execution of AstConst returns the value of that constant.

Certain other functions may choose not to evaluate all their arguments (for example boolean expressions providing short-circuit evaluation).

Specified by:

exec in class AstRoot

toJavaString

public java.lang.String toJavaString()

Overrides:

toJavaString in class AstParameter

columns

public int[] columns(java.lang.String[] names)

Overrides:

columns in class AstParameter

getStr

public java.lang.String getStr()