Classes and Interfaces
BooleanOperatorEqtok	Represents a boolean operator such as AND or OR encountered while parsing an equation.
CalendarLiteralEqtok	Represents an "calendar" literal such as 30d or 6M encountered while parsing an equation.
ConditionalDirectiveEqtok	Represents a conditional directive such as IF and SKIP.
ElseDirectiveEqtok	Represents ELSE directive encountered while parsing an equation.
EquationTokenBase	Base class that provides for common attributes of equation tokens, all "true" concrete content token implementations derive from this class.
ExecutableDirectiveEqtok	Represents an executable directive such as THEN, ELSE and FIRST.
ExitDirectiveEqtok	Represents EXIT directive encountered while parsing an equation.
ExternalVariableEqtok	Represents a Mapper named or numbered variable, array or string bounds reference encountered while parsing an equation.
FirstDirectiveEqtok	Represents FIRST directive encountered while parsing an equation.
FloatLiteralEqtok	Represents an floating point literal (e.g., 1776, +1, -05) encountered while parsing an equation.
FunctionEqtok	Represents a function such as ABS or PI encountered while parsing an equation.
GroupBeginEqtok	Represents the beginning of a group of terms (i.e., left parenthesis) encountered while parsing an equation.
GroupEndEqtok	Represents the end of a group of terms (i.e., right parenthesis) encountered while parsing an equation.
IDirectiveEqtok	Marker interface for a directive such as IF, THEN, SKIP, FIRST, etc. encountered when parsing an equation.
IEquationToken	Represents a token parsed from a CAL or DC equation, or a CHG calculation expression.
IfDirectiveEqtok	Represents IF directive encountered while parsing an equation.
ILiteralEqtok	Marker interface for a numeric or string literal encountered while parsing an equation.
IntegerLiteralEqtok	Represents an integer literal (e.g., 1776, +1, -05) encountered while parsing an equation.
InternalVariableEqtok	Represents a variable encountered while parsing an equation that is internal to the command and equation, as opposed to an external Mapper variable declared by LDV or LDA.
IOperatorEqtok	Represents a binary or unary operator such as +, * and = encountered while parsing an equation.
IVariableEqtok	Represents a variable reference encountered while parsing an equation.
MathOperatorEqtok	Represents a mathematical operator such as addition (+) or multiplication (*) encountered while parsing an equation.
OperatorEqtokBase	Simple, abstract, base implementation of precedence for operator tokens.
RelationalOperatorEqtok	Represents a relational operator such as equals (=), greater (>) or less-than-or-equal (<=, =<) encountered while parsing an equation.
ReservedWordEqtok	Represents a Mapper reserved word (e.g., DRW$) encountered while parsing an equation.
SkipDirectiveEqtok	Represents SKIP directive encountered while parsing an equation.
StringLiteralEqtok	Represents a string literal (e.g., "hello, world" or 'hello, yourself') encountered while parsing an equation.
ThenDirectiveEqtok	Represents THEN directive encountered while parsing an equation.

Class: BooleanOperatorEqtok   next package

Represents a boolean operator such as AND or OR encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Boolean operator represented by this token. public final com.arsi.mj.maprpt.lexer.ptree.symbol.BooleanOperator operator

Constructors

Public ctor for initializing an instance of this class. Parameters: aBoolop - Boolean operator represented by this token. aPrecedence - relative magnitude for ordering evaluation of operations. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public BooleanOperatorEqtok(com.arsi.mj.maprpt.lexer.ptree.symbol.BooleanOperator aBoolop, int aPrecedence, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: CalendarLiteralEqtok   previous next package

Represents an "calendar" literal such as 30d or 6M encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Calendar part of literal (e.g., M, D, Y). public final java.lang.Character calendarMnemonic

Value of calendar literal in days (e.g.,. 1Y = 365 days). public final java.lang.Long days

Value of original integer part of literal. public final java.lang.Long literal

Constructors

Public ctor for initializing an instance of this class. Parameters: aLiteral - integer literal value. aMnemonic - upper case mnemonic that identifies the type of calendar unit (e.g., 'D' = days). aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public CalendarLiteralEqtok(java.lang.Long aLiteral, java.lang.Character aMnemonic, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: ConditionalDirectiveEqtok   previous next package

Represents a conditional directive such as IF and SKIP.

Constructors

Restricted ctor for initializing an instance of this class. Parameters: aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). protected ConditionalDirectiveEqtok(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: ElseDirectiveEqtok   previous next package

Represents ELSE directive encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Token in equation that represents this directive. public static final java.lang.String ELSE_TOKEN = "ELSE"

Constructors

Public ctor for initializing an instance of this class. Parameters: aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public ElseDirectiveEqtok(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: EquationTokenBase   previous next package

Base class that provides for common attributes of equation tokens, all "true" concrete content token implementations derive from this class.
Treat this class as essentially "thread-safe", since it's state is intended to be immutable once created.

Constructors

Restricted ctor for initializing an instance of this class. Parameters: aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). protected EquationTokenBase(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Methods

public java.lang.Integer getCodeBlockId()

public final com.arsi.mj.maprpt.parser.line.types.AtLine getHostLine()

public long getOrdinal()

public final int getTokenIndex()

public void setCodeBlockId(java.lang.Integer anId)

Class: ExecutableDirectiveEqtok   previous next package

Represents an executable directive such as THEN, ELSE and FIRST.

Constructors

Restricted ctor for initializing an instance of this class. Parameters: aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). protected ExecutableDirectiveEqtok(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: ExitDirectiveEqtok   previous next package

Represents EXIT directive encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Token in equation that represents this directive. public static final java.lang.String EXIT_TOKEN = "EXIT"

Constructors

Public ctor for initializing an instance of this class. Parameters: aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public ExitDirectiveEqtok(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: ExternalVariableEqtok   previous next package

Represents a Mapper named or numbered variable, array or string bounds reference encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Concatenation expression composed of a single IVariableDerefExpr. public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr variableExpr

Constructors

Public ctor for initializing an instance of this class. Parameters: aVarExpr - concatenation expression composed of a single variable dereference. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public ExternalVariableEqtok(com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr aVarExpr, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: FirstDirectiveEqtok   previous next package

Represents FIRST directive encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Token in equation that represents this directive. public static final java.lang.String FIRST_TOKEN = "FIRST"

Constructors

Public ctor for initializing an instance of this class. Parameters: aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public FirstDirectiveEqtok(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: FloatLiteralEqtok   previous next package

Represents an floating point literal (e.g., 1776, +1, -05) encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Value of floating point literal. public final java.lang.Double literal

Constructors

Public ctor for initializing an instance of this class. Parameters: aLiteral - floating point literal value. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public FloatLiteralEqtok(java.lang.Double aLiteral, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: FunctionEqtok   previous next package

Represents a function such as ABS or PI encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Function represented by this token. public final com.arsi.mj.maprpt.lexer.ptree.cmd.equation.function.IEquationFunction function

Function arguments, if any, as tokenized equations themselves. public final java.util.List functionArgs

Constructors

Public ctor for initializing an instance of this class. Parameters: aFunction - function represented by this token. someFunctionArgs - function arguments, if any (list can be empty), as tokenized equations themselves. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public FunctionEqtok(com.arsi.mj.maprpt.lexer.ptree.cmd.equation.function.IEquationFunction aFunction, java.util.List someFunctionArgs, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: GroupBeginEqtok   previous next package

Represents the beginning of a group of terms (i.e., left parenthesis) encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Constructors

Public ctor for initializing an instance of this class. Parameters: aLiteral - string literal value. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public GroupBeginEqtok(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: GroupEndEqtok   previous next package

Represents the end of a group of terms (i.e., right parenthesis) encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Constructors

Public ctor for initializing an instance of this class. Parameters: aLiteral - string literal value. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public GroupEndEqtok(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Interface: IDirectiveEqtok   previous next package

Marker interface for a directive such as IF, THEN, SKIP, FIRST, etc. encountered when parsing an equation.

Interface: IEquationToken   previous next package

Represents a token parsed from a CAL or DC equation, or a CHG calculation expression.

Fields

Code block for FIRST: nodes (lowest possible coe block ID) public static final java.lang.Integer INITIALIZER_CODE_BLOCK

Methods

Get identifier that organizes code on the same Mapper line into "code blocks" so equation constructs like SKIP: and FIRST: can be handled properly. Returns: identifies the code block this equation token belongs to, if any (can be NULL). public java.lang.Integer getCodeBlockId()

Get at-sign line from which equation token was parsed. Returns: at-sign line from which equation token was parsed. public com.arsi.mj.maprpt.parser.line.types.AtLine getHostLine()

Get ordinal that allows for relative ordering of tokens according to the sequence in which tokens were parsed. Returns: ordinal that is higher than tokens that precede this token in the input, and lower than tokens that occur after this token in the input. public long getOrdinal()

Get index of first character of token in at-sign line (not counting first character in at-sign line). Returns: index of first character of token in at-sign line (not counting first character in at-sign line). public int getTokenIndex()

Class: IfDirectiveEqtok   previous next package

Represents IF directive encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Token in equation that represents this directive. public static final java.lang.String IF_TOKEN = "IF"

Constructors

Public ctor for initializing an instance of this class. Parameters: aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public IfDirectiveEqtok(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Interface: ILiteralEqtok   previous next package

Marker interface for a numeric or string literal encountered while parsing an equation.

Class: IntegerLiteralEqtok   previous next package

Represents an integer literal (e.g., 1776, +1, -05) encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Value of integer literal. public final java.lang.Long literal

Constructors

Public ctor for initializing an instance of this class. Parameters: aLiteral - integer literal value. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public IntegerLiteralEqtok(java.lang.Long aLiteral, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: InternalVariableEqtok   previous next package

Represents a variable encountered while parsing an equation that is internal to the command and equation, as opposed to an external Mapper variable declared by LDV or LDA. For example, internal variables for CAL and DC commands are letters of the alphabet by default.
Treat this class as thread-safe since it is immutable once created.

Fields

String bounds to apply to variable, if any (can be NULL). public final com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds bounds

Name of variable. public final java.lang.String variableName

Constructors

Public ctor for initializing an instance of this class. Parameters: aName - name of internal variable. aBounds - string bounds to apply to variable, if any (can be NULL). aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public InternalVariableEqtok(java.lang.String aName, com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds aBounds, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Methods

Get options that apply to equation that sets the value of this variable (variable is left-hand-side of assignment, options apply to equation on right-hand-side of assignment). Returns: equation options and arguments, if any (can be NULL). public com.arsi.mj.maprpt.lexer.ptree.cmd.equation.EquationOptions getEquationOptions()

Set options that apply to equation that sets the value of this variable. Parameters: someOptions - equation options and arguments. public void setEquationOptions(com.arsi.mj.maprpt.lexer.ptree.cmd.equation.EquationOptions someOptions)

Interface: IOperatorEqtok   previous next package

Represents a binary or unary operator such as +, * and = encountered while parsing an equation.

Methods

Get precedence of this operator as relative magnitude. Returns: relative, integer magnitude to be used to order evaluation of operations. public int getPrecedence()

Interface: IVariableEqtok   previous next package

Represents a variable reference encountered while parsing an equation.

Class: MathOperatorEqtok   previous next package

Represents a mathematical operator such as addition (+) or multiplication (*) encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Mathematical operator represented by this token. public final com.arsi.mj.maprpt.lexer.ptree.symbol.MathOperator operator

Constructors

Public ctor for initializing an instance of this class. Parameters: aMathop - Mathematical operator represented by this token. aPrecedence - relative magnitude for ordering evaluation of operations. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public MathOperatorEqtok(com.arsi.mj.maprpt.lexer.ptree.symbol.MathOperator aMathop, int aPrecedence, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: OperatorEqtokBase   previous next package

Simple, abstract, base implementation of precedence for operator tokens.

Constructors

Restricted ctor for initializing an instance of this class. Parameters: aPrecedence - relative magnitude for ordering evaluation of operations. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). protected OperatorEqtokBase(int aPrecedence, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Methods

public int getPrecedence()

Class: RelationalOperatorEqtok   previous next package

Represents a relational operator such as equals (=), greater (>) or less-than-or-equal (<=, =<) encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Relational operator represented by this token. public final com.arsi.mj.maprpt.lexer.ptree.symbol.RelationalOperator operator

Constructors

Public ctor for initializing an instance of this class. Parameters: aRelop - relational operator represented by this token. aPrecedence - relative magnitude for ordering evaluation of operations. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public RelationalOperatorEqtok(com.arsi.mj.maprpt.lexer.ptree.symbol.RelationalOperator aRelop, int aPrecedence, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: ReservedWordEqtok   previous next package

Represents a Mapper reserved word (e.g., DRW$) encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Reserved word parsed from equation. public final com.arsi.mj.maprpt.lexer.ptree.rsvd.IReservedWord reserved

Constructors

Public ctor for initializing an instance of this class. Parameters: aReserved - reserved word parsed from equation. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public ReservedWordEqtok(com.arsi.mj.maprpt.lexer.ptree.rsvd.IReservedWord aReserved, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: SkipDirectiveEqtok   previous next package

Represents SKIP directive encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Token in equation that represents this directive. public static final java.lang.String SKIP_TOKEN = "SKIP"

Constructors

Public ctor for initializing an instance of this class. Parameters: aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public SkipDirectiveEqtok(com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)

Class: StringLiteralEqtok   previous next package

Represents a string literal (e.g., "hello, world" or 'hello, yourself') encountered while parsing an equation.
Treat this class as thread-safe since it is immutable once created.

Fields

Value of string literal. public final java.lang.String literal

Constructors

Public ctor for initializing an instance of this class. Parameters: aLiteral - string literal value. aLine - at-sign line from which equation token was parsed. aTokenIndex - index of first character of token in at-sign line (not counting first character in at-sign line). public StringLiteralEqtok(java.lang.String aLiteral, com.arsi.mj.maprpt.parser.line.types.AtLine aLine, int aTokenIndex)