Follow the links below to browse sample Javadoc for MJ classes and tools, including the MJ Runtime Library.

 

Package: com.arsi.mj.maprpt.lexer.ptree.expr  previous next contents

Package com.arsi.mj.maprpt.lexer.ptree.expr contains the following classes and interfaces.
Classes and Interfaces
ArraySubscriptExpr Array subscript expression that combines an array subscript with a variable that is dereferenced by the subscript.
CharCmdOptionConcatExpr A concatenation expression that wraps the various ways a single-character command option may be specified.
ConcatExpr Expression that is simply the concatenation of other expressions, and is used to print data in Mapper and to initialize variables.
DeclaredVariableExpr Variable declaring expression that combines a variable type and size with a variable reference, e.g., <myVar>s20 or V55f6.2.
ICommandOptionExpr Defines an expression that represents the various ways a command option may be specified in a Mapper RUN command.
IMaprptExpr Denotes a parsed Mapper expression of some kind.
IVariableDerefExplicitExpr Marker interface that denotes an expression that directly and explicitly dereferences a variable, i.e., provides a direct path to access the value of a specific variable.
IVariableDerefExpr Marker interface that denotes an expression that dereferences a variable, i.e., provides a path to access the value of a variable.
IVariableDerefImpliedExpr Marker interface that denotes an expression that indirectly or implicitly dereferences a variable, i.e., provides a path that ultimately accesses the value of a variable.
ReservedWordExpr Expression that represents a reserved word.
ReservedWordRefmtExpr Formatting expression that combines formatting directive with a reserved word or string bounds that is dereferenced by the directive.
ReservedWordStrboundsExpr Substring expression that combines a string bounds with a variable or array that is dereferenced by the bounds.
StrCmdOptionConcatExpr A concatenation expression that wraps the various ways a string-valued command option may be specified.
TextExpr Expression that represents text.
VariableReferenceExpr Expression that represents a variable.
VariableRefmtExpr Formatting expression that combines formatting directive with a a string bounds, variable or array member that is dereferenced by the directive.
VariableStrboundsExpr Substring expression that combines a string bounds with a variable or array that is dereferenced by the bounds.

Class: ArraySubscriptExpr   next package

Array subscript expression that combines an array subscript with a variable that is dereferenced by the subscript.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.ArraySubscriptExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExplicitExpr
Fields
Array subscript to apply to variable.
public final com.arsi.mj.maprpt.lexer.ptree.symbol.ArraySubscript subscript
Variable dereferenced by subscript.
public final com.arsi.mj.maprpt.lexer.ptree.expr.VariableReferenceExpr variableExpr
Constructors
Initializes an instance of this class.
Parameters:
aSubscr - array subscript to apply to variable.
aVariableExpr - variable dereferenced by subscript.
public ArraySubscriptExpr(com.arsi.mj.maprpt.lexer.ptree.symbol.ArraySubscript aSubscr, com.arsi.mj.maprpt.lexer.ptree.expr.VariableReferenceExpr aVariableExpr)
Methods
public com.arsi.mj.maprpt.lexer.symtab.VarArrayType arrayTypeForSymbolTable()
public boolean equals(java.lang.Object anObject)
public int hashCode()
public java.lang.String toMapperString()
public com.arsi.mj.maprpt.lexer.symtab.VariableIdentity variableIdentityForSymbolTable()
public com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference variableReference()

Class: CharCmdOptionConcatExpr   previous next package

A concatenation expression that wraps the various ways a single-character command option may be specified. For example, while a command option is usually an alphabetic literal such as LDV,U, the option might be stored as a quoted string or even a variable (e.g., LDV,'U' or LDV,v25).
Parameters:
<E> - the enumeration that lists the command options and is wrapped by this class. The enumeration must implement a static method fromLetter with the following signature for reflection to work: 
     public static E fromLetter(final char aLetter);
public class com.arsi.mj.maprpt.lexer.ptree.expr.CharCmdOptionConcatExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.ICommandOptionExpr
Constructors
Initializes an instance of this class.
Parameters:
aKlass - class of enumeration, which cannot be derived from generic E and must be passed.
anOptionChar - a valid option character.
aUserRID - report ID string that is meaningful to user as an error context.
aLineNumber - line number in report where command option occurs.
public CharCmdOptionConcatExpr(java.lang.Class aKlass, char anOptionChar, java.lang.String aUserRID, int aLineNumber)
Initializes an instance of this class.
Parameters:
aKlass - class of enumeration, which cannot be derived from generic E and must be passed.
aSimpleExpr - a "simple" concatenation expression, either text or a variable dereference.
aUserRID - report ID string that is meaningful to user as an error context.
aLineNumber - line number in report where command option occurs.
public CharCmdOptionConcatExpr(java.lang.Class aKlass, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr aSimpleExpr, java.lang.String aUserRID, int aLineNumber)
Initializes an instance of this class.
Parameters:
aKlass - class of enumeration, which cannot be derived from generic E and must be passed.
anOptionString - one or more valid option characters.
aUserRID - report ID string that is meaningful to user as an error context.
aLineNumber - line number in report where command option occurs.
public CharCmdOptionConcatExpr(java.lang.Class aKlass, java.lang.String anOptionString, java.lang.String aUserRID, int aLineNumber)
Methods
public java.util.EnumSet options()
public java.util.List optionVariable()

Class: ConcatExpr   previous next package

Expression that is simply the concatenation of other expressions, and is used to print data in Mapper and to initialize variables.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr, com.arsi.mj.maprpt.lexer.symtab.ISupportsVariableReference
Constructors
Initializes an instance of this class.
public ConcatExpr()
Initializes an instance of this class.
Parameters:
anExpr - expression to concatenate.
public ConcatExpr(com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr anExpr)
Methods
Concatenate expression with other expressions, appending value of expression.
Parameters:
anExpr - expression to concatenate.
public void concat(com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr anExpr)
public boolean equals(java.lang.Object anObject)
Get expressions to concatenate.
Returns:
list of expressions to concatenate.
public final java.util.List expressionsToConcat()
public int hashCode()
public java.util.List referencedVariables()
public java.lang.String toMapperString()

Class: DeclaredVariableExpr   previous next package

Variable declaring expression that combines a variable type and size with a variable reference, e.g., <myVar>s20 or V55f6.2. Such variable declarations may occur instead of more typical variable dereferences (e.g., V55f6.2 instead of v55) while parsing commands not dedicated to variable definition such as LDV.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.DeclaredVariableExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExplicitExpr
Fields
Type and size of variable (e.g., s20, i5).
public final com.arsi.mj.maprpt.lexer.ptree.symbol.VariableTypeSize typeSize
Variable being declared, simple variables only (no arrays, string bounds or initializers).
public final com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference varRef
Constructors
Initializes an instance of this class.
Parameters:
aTypeSize - type and size of variable.
aVariableExpr - simple variable that is being declared (no arrays, string bounds or initializers).
public DeclaredVariableExpr(com.arsi.mj.maprpt.lexer.ptree.symbol.VariableTypeSize aTypeSize, com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference aVariableExpr)
Methods
public com.arsi.mj.maprpt.lexer.symtab.VarArrayType arrayTypeForSymbolTable()
public boolean equals(java.lang.Object anObject)
public int hashCode()
public java.lang.String toMapperString()
public com.arsi.mj.maprpt.lexer.symtab.VariableIdentity variableIdentityForSymbolTable()
public com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference variableReference()

Interface: ICommandOptionExpr   previous next package

Defines an expression that represents the various ways a command option may be specified in a Mapper RUN command. For example, while a command option is usually an alphabetic literal such as LDV,U, the option might be stored as a quoted string or even a variable.
Parameters:
<E> - the enumeration that lists the command options.
public interface com.arsi.mj.maprpt.lexer.ptree.expr.ICommandOptionExpr
Methods
Convert expression to set of command options.
Returns:
command options as enumeration set.
public java.util.EnumSet options()
Get variable(s) in expression that contains options that are typically evaluated at run-time.
Returns:
variable(s) in expression that contain option(s) or empty list if none (meaning value of options expression can be easily determined at compile time).
public java.util.List optionVariable()

Interface: IMaprptExpr   previous next package

Denotes a parsed Mapper expression of some kind.
public interface com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr
Methods
Convert expression to Mapper source string.
Returns:
expression as Mapper source string.
public java.lang.String toMapperString()

Interface: IVariableDerefExplicitExpr   previous next package

Marker interface that denotes an expression that directly and explicitly dereferences a variable, i.e., provides a direct path to access the value of a specific variable.
public interface com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExplicitExpr
  extends com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExpr

Interface: IVariableDerefExpr   previous next package

Marker interface that denotes an expression that dereferences a variable, i.e., provides a path to access the value of a variable.
public interface com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExpr
  extends com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr
Methods
Get indication that expression dereferences an array or scalar variable, for use by control flow symbol table.
Returns:
indicator expression that dereferences array, array element or scalar variable.
public com.arsi.mj.maprpt.lexer.symtab.VarArrayType arrayTypeForSymbolTable()
Convert variable dereference expression 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()
Get basic definition of variable to dereference.
Returns:
basic definition of variable to dereference.
public com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference variableReference()

Interface: IVariableDerefImpliedExpr   previous next package

Marker interface that denotes an expression that indirectly or implicitly dereferences a variable, i.e., provides a path that ultimately accesses the value of a variable.
public interface com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefImpliedExpr
  extends com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExpr

Class: ReservedWordExpr   previous next package

Expression that represents a reserved word.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.ReservedWordExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr
Fields
Reserved word that this expression represents.
public final com.arsi.mj.maprpt.lexer.ptree.rsvd.IReservedWord reserved
Constructors
Initializes an instance of this class.
Parameters:
aResvWord - reserved word that this expression represents.
public ReservedWordExpr(com.arsi.mj.maprpt.lexer.ptree.rsvd.IReservedWord aResvWord)
Methods
public boolean equals(java.lang.Object anObject)
public int hashCode()
public java.lang.String toMapperString()

Class: ReservedWordRefmtExpr   previous next package

Formatting expression that combines formatting directive with a reserved word or string bounds that is dereferenced by the directive.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.ReservedWordRefmtExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr
Fields
Formatting to apply to reserved word.
public final java.util.EnumSet formats
reserved word or reserved word string bounds dereferenced by formatting directive.
public final com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr reservedOrBoundsExpr
Constructors
Initializes an instance of this class.
Parameters:
someFmts - formatting to apply to variable.
aResvWordExpr - reserved word dereferenced by formatting directive.
public ReservedWordRefmtExpr(java.util.EnumSet someFmts, com.arsi.mj.maprpt.lexer.ptree.expr.ReservedWordExpr aResvWordExpr)
Initializes an instance of this class.
Parameters:
someFmts - formatting to apply to variable.
aResvWordExpr - reserved word string bounds dereferenced by formatting directive.
public ReservedWordRefmtExpr(java.util.EnumSet someFmts, com.arsi.mj.maprpt.lexer.ptree.expr.ReservedWordStrboundsExpr aResvWordExpr)
Methods
public boolean equals(java.lang.Object anObject)
public int hashCode()
public java.lang.String toMapperString()

Class: ReservedWordStrboundsExpr   previous next package

Substring expression that combines a string bounds with a variable or array that is dereferenced by the bounds.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.ReservedWordStrboundsExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr
Fields
String bounds to apply to reserved word.
public final com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds bounds
Reserved word dereferenced by bounds.
public final com.arsi.mj.maprpt.lexer.ptree.expr.ReservedWordExpr reservedExpr
Constructors
Initializes an instance of this class.
Parameters:
aBounds - string bounds to apply to reserved word.
aResvWordExpr - reserved word dereferenced by substring bounds.
public ReservedWordStrboundsExpr(com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds aBounds, com.arsi.mj.maprpt.lexer.ptree.expr.ReservedWordExpr aResvWordExpr)
Methods
public boolean equals(java.lang.Object anObject)
public int hashCode()
public java.lang.String toMapperString()

Class: StrCmdOptionConcatExpr   previous next package

A concatenation expression that wraps the various ways a string-valued command option may be specified. For example, while a command option is usually an alphabetic literal such as IF,D1, the option might be stored as a quoted string or even a variable (e.g., IF,'D1' or IF,v25).
Parameters:
<E> - the enumeration that lists the command options and is wrapped by this class. The enumeration must implement a static method fromString with the following signature for reflection to work: 
     public static E fromString(final String aStropt);
public class com.arsi.mj.maprpt.lexer.ptree.expr.StrCmdOptionConcatExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.ICommandOptionExpr
Constructors
Initializes an instance of this class.
Parameters:
aKlass - class of enumeration, which cannot be derived from generic E and must be passed.
aSimpleExpr - a "simple" concatenation expression, either text or a variable dereference.
aUserRID - report ID string that is meaningful to user as an error context.
aLineNumber - line number in report where command option occurs.
public StrCmdOptionConcatExpr(java.lang.Class aKlass, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr aSimpleExpr, java.lang.String aUserRID, int aLineNumber)
Methods
public java.util.EnumSet options()
public java.util.List optionVariable()

Class: TextExpr   previous next package

Expression that represents text.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.TextExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr
Fields
Text represented by this expression.
public final java.lang.String text
Constructors
Initializes an instance of this class.
Parameters:
aText - text represented by this expression.
public TextExpr(java.lang.String aText)
Methods
public boolean equals(java.lang.Object anObject)
public int hashCode()
public java.lang.String toMapperString()

Class: VariableReferenceExpr   previous next package

Expression that represents a variable.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.VariableReferenceExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExplicitExpr
Fields
Variable that this expression represents.
public final com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference variableRef
Constructors
Initializes an instance of this class.
Parameters:
aVarRef - variable that this expression represents.
public VariableReferenceExpr(com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference aVarRef)
Methods
public com.arsi.mj.maprpt.lexer.symtab.VarArrayType arrayTypeForSymbolTable()
public boolean equals(java.lang.Object anObject)
public int hashCode()
public java.lang.String toMapperString()
public com.arsi.mj.maprpt.lexer.symtab.VariableIdentity variableIdentityForSymbolTable()
public com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference variableReference()

Class: VariableRefmtExpr   previous next package

Formatting expression that combines formatting directive with a a string bounds, variable or array member that is dereferenced by the directive.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.VariableRefmtExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr, com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExpr
Fields
Formatting to apply to variable.
public final java.util.EnumSet formats
Variable dereferenced by formatting directive.
public final com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExpr variableExpr
Constructors
Initializes an instance of this class.
Parameters:
someFmts - formatting to apply to variable.
aVarExpr - variable dereferenced by formatting directive.
public VariableRefmtExpr(java.util.EnumSet someFmts, com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExpr aVarExpr)
Methods
public com.arsi.mj.maprpt.lexer.symtab.VarArrayType arrayTypeForSymbolTable()
public boolean equals(java.lang.Object anObject)
public int hashCode()
public java.lang.String toMapperString()
public com.arsi.mj.maprpt.lexer.symtab.VariableIdentity variableIdentityForSymbolTable()
public com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference variableReference()

Class: VariableStrboundsExpr   previous package

Substring expression that combines a string bounds with a variable or array that is dereferenced by the bounds.
Treat this class as "thread-safe", since it is immutable once created.
public class com.arsi.mj.maprpt.lexer.ptree.expr.VariableStrboundsExpr
  extends java.lang.Object
  implements com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefImpliedExpr
Fields
String bounds to apply to variable.
public final com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds bounds
Variable dereferenced by bounds.
public final com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExplicitExpr variableExpr
Constructors
Initializes an instance of this class.
Parameters:
aBounds - string bounds to apply to variable.
aVarExpr - variable dereferenced by substring bounds.
public VariableStrboundsExpr(com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds aBounds, com.arsi.mj.maprpt.lexer.ptree.expr.IVariableDerefExplicitExpr aVarExpr)
Methods
public com.arsi.mj.maprpt.lexer.symtab.VarArrayType arrayTypeForSymbolTable()
public boolean equals(java.lang.Object anObject)
public int hashCode()
public java.lang.String toMapperString()
public com.arsi.mj.maprpt.lexer.symtab.VariableIdentity variableIdentityForSymbolTable()
public com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference variableReference()