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

 

Package: com.arsi.mj.maprpt.lexer.symtab.vardecl  previous next contents

Package com.arsi.mj.maprpt.lexer.symtab.vardecl contains the following classes and interfaces.
Classes and Interfaces
ISupportsScalarDeclaration Defines mechanism for target parse node (or other object) to list scalar variables declared.
VarDeclBase Abstract base class that represents a variable declaration.
VarDeclPeekData Variable declaration where the size of data (e.g., column) from a report or result must be "peeked at" to properly determine the precision (and scale, where applicable) of the target variable .
VarDeclPeekPrecision Variable declaration where value of another variable must be "peeked at" to properly determine the precision of the declared variable; the scale is known at compile time.
VarDeclPeekScale Variable declaration where value of another variable must be "peeked at" to properly determine the scale of the declared variable; the precision is known at compile time.
VarDeclPeekSize Variable declaration where value of other variable(s) must be "peeked at" to properly determine the size (precision and optional scale) of the declared variable.
VarDeclStaticSize Variable declaration where size (precision and scale) is static, i.e., known at compile-time.

Interface: ISupportsScalarDeclaration   next package

Defines mechanism for target parse node (or other object) to list scalar variables declared.
public interface com.arsi.mj.maprpt.lexer.symtab.vardecl.ISupportsScalarDeclaration
Methods
Enumerate all scalar variables declared by parse node (or other object).
Returns:
list of variable declaration information.
public java.util.List declareScalarVariables()

Class: VarDeclBase   previous next package

Abstract base class that represents a variable declaration.
public abstract class com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase
  extends java.lang.Object
Inner Class VarDeclIdentity
Nested class that represents identity of variable being declared.
public static class com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase.VarDeclIdentity
  extends com.arsi.mj.maprpt.lexer.symtab.VariableIdentity
Public ctor for initializing an instance of this class.
Parameters:
anIdentity - identity of variable.
public VarDeclBase.VarDeclIdentity(com.arsi.mj.maprpt.lexer.symtab.VariableIdentity anIdentity)
Public ctor for initializing an instance of this class.
Parameters:
anIdentType - identifies variable as named or numbered.
anIdentValue - name (String) or number (Integer) of variable.
aScope - scope of variable.
public VarDeclBase.VarDeclIdentity(com.arsi.mj.maprpt.lexer.symtab.VarIdentType anIdentType, java.lang.Object anIdentValue, com.arsi.mj.VariableScope aScope)
Get canonical variable identity for comparing to other identities in symbol table.
Returns:
canonical variable identity for comparison and lookup.
public com.arsi.mj.maprpt.lexer.symtab.VariableIdentity variableIdentityForSymbolTable()
Fields
Fundamental, scalar type being voted for.
protected com.arsi.mj.datatype.MaprptDataType dataType
Identifies variable being declared.
protected final com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase.VarDeclIdentity variableIdentity
Variable type as it would be specified in a Mapper RUN.
protected com.arsi.mj.maprpt.lexer.ptree.cmd.MaprptVariableType variableType
Constructors
Restricted ctor for initializing an instance of this class.
Parameters:
aDataType - fundamental, scalar type of declared variable.
aVariableType - type of declared variable as it would be specified in a Mapper RUN.
aVarDeclIdent - identifies declared variable.
protected VarDeclBase(com.arsi.mj.datatype.MaprptDataType aDataType, com.arsi.mj.maprpt.lexer.ptree.cmd.MaprptVariableType aVariableType, com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase.VarDeclIdentity aVarDeclIdent)
Methods
Create a variable declaration for symbol table from variable name or number and variable type and size parsed by lexer.
Parameters:
aVarRef - object created by lexer that contains variable name or number.
aTypeSize - object created by lexer that specifies variable type and size.
Returns:
variable declaration for use with symbol table or NULL if appropriate declaration could not be determined.
public static com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase create(com.arsi.mj.maprpt.lexer.ptree.symbol.VariableReference aVarRef, com.arsi.mj.maprpt.lexer.ptree.symbol.VariableTypeSize aTypeSize)
Get fundamental, scalar type of variable.
public com.arsi.mj.datatype.MaprptDataType dataType()
Identifies declared variable.
public final com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase.VarDeclIdentity variableIdentity()
Get variable type being voted for as it would be specified in a Mapper RUN.
public com.arsi.mj.maprpt.lexer.ptree.cmd.MaprptVariableType variableType()

Class: VarDeclPeekData   previous next package

Variable declaration where the size of data (e.g., column) from a report or result must be "peeked at" to properly determine the precision (and scale, where applicable) of the target variable .
public class com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclPeekData
  extends com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase
Fields
Identifies report-or-result-to-peek-at.
public final com.arsi.mj.maprpt.lexer.ptree.symbol.Cdr cdr
String bounds (e.g., (4-7)) that identifies column where data resides, NULL if dataName is not NULL.
public final com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds dataBounds
Name of column (as string TextExpr or variable reference IVariableDerefExpr) that identifies column where data resides, NULL if dataBounds is not NULL.
public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr dataName
Constructors
Public ctor for initializing an instance of this class.
Parameters:
aCdr - identifies report-or-result-to-peek-at.
aDataName - name of column (as string TextExpr or variable reference IVariableDerefExpr) that identifies column where data resides, NULL if position and length (bounds) identifies column instead of name.
aDataBounds - name of column (as string TextExpr or variable reference IVariableDerefExpr) that identifies column where data resides, NULL if name identifies column instead of position and length.
aDataType - fundamental, scalar type of declared variable.
aVariableType - type of declared variable as it would be specified in a Mapper RUN.
aVarDeclIdent - identifies declared variable.
public VarDeclPeekData(com.arsi.mj.maprpt.lexer.ptree.symbol.Cdr aCdr, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr aDataName, com.arsi.mj.maprpt.lexer.ptree.symbol.StringBounds aDataBounds, com.arsi.mj.datatype.MaprptDataType aDataType, com.arsi.mj.maprpt.lexer.ptree.cmd.MaprptVariableType aVariableType, com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase.VarDeclIdentity aVarDeclIdent)

Class: VarDeclPeekPrecision   previous next package

Variable declaration where value of another variable must be "peeked at" to properly determine the precision of the declared variable; the scale is known at compile time.
public class com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclPeekPrecision
  extends com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase
Fields
Identifies variable-to-peek-at to get precision.
public final com.arsi.mj.maprpt.lexer.symtab.VariableReferenceIdentity peekPrecisionVarRefIdent
Compile-time scale of variable.
public final java.lang.Integer scale
Constructors
Public ctor for initializing an instance of this class.
Parameters:
aPrecisionVarRefIdent - identifies variable-to-peek-at to get precision.
aScale - compile-time scale of variable.
aDataType - fundamental, scalar type of declared variable.
aVariableType - type of declared variable as it would be specified in a Mapper RUN.
aVarDeclIdent - identifies declared variable.
public VarDeclPeekPrecision(com.arsi.mj.maprpt.lexer.symtab.VariableReferenceIdentity aPrecisionVarRefIdent, java.lang.Integer aScale, com.arsi.mj.datatype.MaprptDataType aDataType, com.arsi.mj.maprpt.lexer.ptree.cmd.MaprptVariableType aVariableType, com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase.VarDeclIdentity aVarDeclIdent)

Class: VarDeclPeekScale   previous next package

Variable declaration where value of another variable must be "peeked at" to properly determine the scale of the declared variable; the precision is known at compile time.
public class com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclPeekScale
  extends com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase
Fields
Identifies variable-to-peek-at to get scale.
public final com.arsi.mj.maprpt.lexer.symtab.VariableReferenceIdentity peekScaleVarRefIdent
Compile-time precision of variable.
public final java.lang.Integer precision
Constructors
Public ctor for initializing an instance of this class.
Parameters:
aPrecision - compile-time precision of variable.
aScaleVarRefIdent - identifies variable-to-peek-at to get scale.
aDataType - fundamental, scalar type of declared variable.
aVariableType - type of declared variable as it would be specified in a Mapper RUN.
aVarDeclIdent - identifies declared variable.
public VarDeclPeekScale(java.lang.Integer aPrecision, com.arsi.mj.maprpt.lexer.symtab.VariableReferenceIdentity aScaleVarRefIdent, com.arsi.mj.datatype.MaprptDataType aDataType, com.arsi.mj.maprpt.lexer.ptree.cmd.MaprptVariableType aVariableType, com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase.VarDeclIdentity aVarDeclIdent)

Class: VarDeclPeekSize   previous next package

Variable declaration where value of other variable(s) must be "peeked at" to properly determine the size (precision and optional scale) of the declared variable.
public class com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclPeekSize
  extends com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase
Fields
Identifies variable-to-peek-at to get precision.
public final com.arsi.mj.maprpt.lexer.symtab.VariableReferenceIdentity peekPrecisionVarRefIdent
Identifies variable-to-peek-at to get scale, if any (may be NULL).
public final com.arsi.mj.maprpt.lexer.symtab.VariableReferenceIdentity peekScaleVarRefIdent
Constructors
Public ctor for initializing an instance of this class.
Parameters:
aPrecisionVarRefIdent - identifies variable-to-peek-at to get precision.
aScaleVarRefIdent - identifies variable-to-peek-at to get scale, if any (may be NULL).
aDataType - fundamental, scalar type of declared variable.
aVariableType - type of declared variable as it would be specified in a Mapper RUN.
aVarDeclIdent - identifies declared variable.
public VarDeclPeekSize(com.arsi.mj.maprpt.lexer.symtab.VariableReferenceIdentity aPrecisionVarRefIdent, com.arsi.mj.maprpt.lexer.symtab.VariableReferenceIdentity aScaleVarRefIdent, com.arsi.mj.datatype.MaprptDataType aDataType, com.arsi.mj.maprpt.lexer.ptree.cmd.MaprptVariableType aVariableType, com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase.VarDeclIdentity aVarDeclIdent)

Class: VarDeclStaticSize   previous package

Variable declaration where size (precision and scale) is static, i.e., known at compile-time.
public class com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclStaticSize
  extends com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase
Fields
Compile-time precision of variable.
public final java.lang.Integer precision
Compile-time scale of variable.
public final java.lang.Integer scale
Constructors
Public ctor for initializing an instance of this class.
Parameters:
aPrecision - compile-time precision of variable.
aScale - compile-time scale of variable.
aDataType - fundamental, scalar type of declared variable.
aVariableType - type of declared variable as it would be specified in a Mapper RUN.
aVarDeclIdent - identifies declared variable.
public VarDeclStaticSize(java.lang.Integer aPrecision, java.lang.Integer aScale, com.arsi.mj.datatype.MaprptDataType aDataType, com.arsi.mj.maprpt.lexer.ptree.cmd.MaprptVariableType aVariableType, com.arsi.mj.maprpt.lexer.symtab.vardecl.VarDeclBase.VarDeclIdentity aVarDeclIdent)