Classes and Interfaces
ArraySubscript	Represents a parsed array subscript (e.g., [5], [v22]).
BooleanOperator	Represents a boolean operator such as AND or OR.
Cdr	Represents a parsed cabinet-drawer-report (CDR) specification (e.g., 16,B,2) or result number (e.g., -1).
FieldSpecification	A field specification that follows a field declaration in LDV,Q.
MathOperator	Represents a mathematical operator (e.g., +, **).
Reformat	Represents a parsed re-format specification (e.g., (p)).
ReformatStringBounds	Represents a parsed, re-formatting string bounds (e.g., (4-7z)).
RelationalOperator	Represents a relational operator (e.g., EQ, NOT LT).
StringBounds	Represents a parsed string bounds (e.g., (4-7), (v88 - v99[2])).
StringBoundsLimit	An integer character position or count that defines a limit of the string bounds, either an integer literal or expression.
VariableDecl	A variable declaration, e.g., v1s20='hello, world!'
VariableReference	Represents a parsed variable reference (e.g., v100, <myvar>).
VariableTypeSize	Represents a parsed variable type and size (e.g., s20, f7.2).

Class: ArraySubscript   next package

Represents a parsed array subscript (e.g., [5], [v22]).
Treat this class as "thread-safe" since it is immutable.

Fields

Compile-time subscript, NULL if subscriptVariable is not NULL. public final java.lang.Integer subscript

Run-time subscript, NULL if subscript is not NULL. public final com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExpr subscriptVariable

Constructors

Initializes an instance of this class. Parameters: aSubscr - the compile-time array subscript. public ArraySubscript(java.lang.Integer aSubscr)

Initializes an instance of this class. Parameters: aSubscr - the run-time array subscript. public ArraySubscript(com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExpr aSubscr)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Convert symbol to Mapper source string. Returns: symbol as Mapper source string. public java.lang.String toMapperString()

Class: BooleanOperator   previous next package

Represents a boolean operator such as AND or OR.
Treat this class as "thread-safe" since it is immutable.

Fields

The boolean operator. public final com.arsi.mj.maprpt.lexer.ptree.symbol.BooleanOperator.Boolop boolop

Constructors

Initializes an instance of this class. Parameters: aBoolop - boolean operator. public BooleanOperator(com.arsi.mj.maprpt.lexer.ptree.symbol.BooleanOperator.Boolop aBoolop)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Class: Cdr   previous next package

Represents a parsed cabinet-drawer-report (CDR) specification (e.g., 16,B,2) or result number (e.g., -1). Treat this class as "thread-safe" since it is immutable.

Fields

Compile-time or runtime cabinet-drawer-report, NULL if result number instead. public final com.arsi.mj.maprpt.lexer.ptree.symbol.Cdr.CDR cdr

Compile-time or runtime result number, NULL if cabinet-drawer-report instead. public final com.arsi.mj.maprpt.lexer.ptree.symbol.Cdr.ResultIdentifier result

Constructors

public Cdr(com.arsi.mj.maprpt.lexer.ptree.symbol.Cdr.CDR aCdr)

public Cdr(com.arsi.mj.maprpt.lexer.ptree.symbol.Cdr.ResultIdentifier aResult)

Class: FieldSpecification   previous next package

A field specification that follows a field declaration in LDV,Q. Treat this class as "thread-safe" since it is immutable.

Fields

Character used to delimiter the field. public final char delimChar

Ordinal position of delimiter occurrence where this field starts (typically 0=first field). public final int delimPosition

Constructors

public FieldSpecification(int aDelimPosition, char aDelimChar)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Class: MathOperator   previous next package

Represents a mathematical operator (e.g., +, **).
Treat this class as "thread-safe" since it is immutable.

Fields

The mathematical operator. public final com.arsi.mj.maprpt.lexer.ptree.symbol.MathOperator.Mathop mathop

Constructors

Initializes an instance of this class. Parameters: aMathop - mathematical operator. public MathOperator(com.arsi.mj.maprpt.lexer.ptree.symbol.MathOperator.Mathop aMathop)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Class: Reformat   previous next package

Represents a parsed re-format specification (e.g., (p)).
Treat this class as "thread-safe" since it is immutable.

Fields

The type of re-formatting to apply. public final java.util.EnumSet formats

Constructors

Initializes an instance of this class. Parameters: someFmts - format types. public Reformat(java.util.EnumSet someFmts)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Class: ReformatStringBounds   previous next package

Represents a parsed, re-formatting string bounds (e.g., (4-7z)). Treat this class as "thread-safe" since it is immutable.

Fields

Count of characters in substring (can be zero). public final com.arsi.mj.maprpt.lexer.ptree.symbol.StringBoundsLimit count

Re-formatting to apply to bounded string. public final java.util.EnumSet formats

Position to start substring (counting from 1, but can be zero). public final com.arsi.mj.maprpt.lexer.ptree.symbol.StringBoundsLimit position

Constructors

Initializes an instance of this class. Parameters: aPosition - position to start substring (can be zero). aCount - count of characters in substring (can be zero). someFmts - format types. public ReformatStringBounds(com.arsi.mj.maprpt.lexer.ptree.symbol.StringBoundsLimit aPosition, com.arsi.mj.maprpt.lexer.ptree.symbol.StringBoundsLimit aCount, java.util.EnumSet someFmts)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Class: RelationalOperator   previous next package

Represents a relational operator (e.g., EQ, NOT LT).
Treat this class as "thread-safe" since it is immutable.

Fields

Indicates if relational operator is negated, i.e., apply NOT to operator. public final boolean negated

The relational operator. public final com.arsi.mj.maprpt.lexer.ptree.symbol.RelationalOperator.Relop relop

Constructors

Initializes an instance of this class. Parameters: aRelop - relational operator. aNegateFlag - if true, apply NOT to relational operator. public RelationalOperator(com.arsi.mj.maprpt.lexer.ptree.symbol.RelationalOperator.Relop aRelop, boolean aNegateFlag)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Class: StringBounds   previous next package

Represents a parsed string bounds (e.g., (4-7), (v88 - v99[2])). Treat this class as "thread-safe" since it is immutable.

Fields

Count of characters in substring (can be zero). public final com.arsi.mj.maprpt.lexer.ptree.symbol.StringBoundsLimit count

Position to start substring (counting from 1, but can be zero). public final com.arsi.mj.maprpt.lexer.ptree.symbol.StringBoundsLimit position

Constructors

Initializes an instance of this class. Parameters: aPosition - position to start substring (can be zero). aCount - count of characters in substring (can be zero). public StringBounds(com.arsi.mj.maprpt.lexer.ptree.symbol.StringBoundsLimit aPosition, com.arsi.mj.maprpt.lexer.ptree.symbol.StringBoundsLimit aCount)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Convert symbol to Mapper source string. Returns: symbol as Mapper source string, without enclosing parentheses. public java.lang.String toMapperString()

Class: StringBoundsLimit   previous next package

An integer character position or count that defines a limit of the string bounds, either an integer literal or expression.

Fields

Character position or count expression known only at runtime, NULL if compile-time. public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr expr

Literal character position or count known at compile time, NULL if run-time. public final java.lang.Integer literal

Constructors

public StringBoundsLimit(com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr anExpr)

public StringBoundsLimit(int aLiteral)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Convert symbol to Mapper source string. Returns: symbol as Mapper source string. public java.lang.String toMapperString()

Class: VariableDecl   previous next package

A variable declaration, e.g., v1s20='hello, world!'. * Treat this class as "thread-safe" since it is immutable.

Fields

Substring bounds to apply to variable (e.g., (5-3)), may be NULL. public final com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds bounds

Concatenation expression that initializes variable, may be NULL. public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr concatExpr

Field position and delimiter for LDV with Q option, may be NULL if no Q option. public final com.arsi.mj.maprpt.lexer.ptree.symbol.FieldSpecification fldSpec

Array subscript that indicates variable is array member (e.g., [7]), may be NULL. public final com.arsi.mj.maprpt.lexer.ptree.symbol.ArraySubscript subscript

Type and size of variable (e.g., s20, i5), may be NULL. public final com.arsi.mj.maprpt.lexer.ptree.symbol.VariableTypeSize typeSize

Variable name or number and metadata, cannot be NULL. public final com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference varRef

Constructors

public VariableDecl(com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference aVarRef, com.arsi.mj.maprpt.lexer.ptree.symbol.VariableTypeSize aTypeSize, com.arsi.mj.maprpt.lexer.ptree.symbol.ArraySubscript aSubscript, com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds aBounds, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr aConcatExpr, com.arsi.mj.maprpt.lexer.ptree.symbol.FieldSpecification aFldSpec)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Class: VariableReference   previous next package

Represents a parsed variable reference (e.g., v100, <myvar>). Treat this class as "thread-safe" since it is immutable.

Fields

Is this a call-by-value variable passed as an argument to CALL? public boolean isCallByValue

Is this an environmental variable? (e.g., <<$myvar>>) public final boolean isEnvironment

Is this a global variable? (e.g., <<*myvar>>) public final boolean isGlobal

Does this variable use indirection (e.g., vv35, <<myvar>>). public final boolean isIndirect

Name of variable, is NULL if numbered variable, can contain almost any characters. public final java.lang.String variableName

Number of variable, is -1 if named variable. public final int variableNumber

Constructors

Initializes an instance of this class. Parameters: aName - name of variable (without leading * or $ scope indicator) or NULL if numbered variable, can contain almost any characters. aVarnum - number of variable, or -1 if named variable. anIndirectFlag - does this variable use indirection? aGlobalFlag - is this a global variable? anEnvFlag - is this an environmental variable? public VariableReference(java.lang.String aName, int aVarnum, boolean anIndirectFlag, boolean aGlobalFlag, boolean anEnvFlag)

Methods

public boolean equals(java.lang.Object anObject)

public int hashCode()

Is this a call-by-value variable passed as an argument to CALL? Returns: true if variable is call-by-value argument to CALL, false if not. public boolean isCallByValue()

Set indication that this variable is a call-by-value argument to CALL. Parameters: aCBVFlag - true if variable is call-by-value argument to CALL, false if not. public void setCallByValue(boolean aCBVFlag)

Convert symbol to Mapper source string. Returns: symbol as Mapper source string. public java.lang.String toMapperString()

Convert parse tree symbol to variable identity useful to control flow symbol table. Returns: variable identity useful to control flow symbol table. public com.arsi.mj.maprpt.lexer.symtab.VariableIdentity variableIdentityForSymbolTable()