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.cmd.sc.directive.edit  previous next contents

Package com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit contains the following classes and interfaces.
Classes and Interfaces
EditBodyDirectiveNode Base class for a parse node that represents an EDIT body SC directive.
EditDateRangeDirectiveNode Base class for a parse node that represents an EDIT body D SC directive.
EditDateRangeDirectiveParser Parses the D sub-directive for the EDIT SC directive.
EditDynamicListDirectiveNode Base class for a parse node that represents an EDIT body RLOV SC directive.
EditDynamicListDirectiveParser Parses the RLOV sub-directive for the EDIT SC directive.
EditFieldReference A field specification referenced in the EIDT intro node.
EditIntegerRangeDirectiveNode Base class for a parse node that represents an EDIT body N SC directive.
EditIntegerRangeDirectiveParser Parses the N sub-directive for the EDIT SC directive.
EditIntroDirectiveNode Base class for a parse node that represents an EDIT intro SC directive.
EditIntroDirectiveParser Parses the intro sub-directive for the EDIT SC directive.
EditListOfValuesDirectiveNode Base class for a parse node that represents an EDIT body value list SC directive.
EditRequiredDirectiveNode Base class for a parse node that represents an EDIT body REQD SC directive.
EditRequiredDirectiveParser Parses the REQD sub-directive for the EDIT SC directive.
EditStaticListDirectiveNode Base class for a parse node that represents an EDIT body LOV SC directive.
EditStaticListDirectiveParser Parses the LOV sub-directive for the EDIT SC directive.
EditTimeRangeDirectiveNode Base class for a parse node that represents an EDIT body T SC directive.
EditTimeRangeDirectiveParser Parses the T sub-directive for the EDIT SC directive.

Class: EditBodyDirectiveNode   next package

Base class for a parse node that represents an EDIT body SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public abstract class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditBodyDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveNode
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
protected EditBodyDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine)
Methods
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditIntroDirectiveNode getIntro()
public void setIntro(com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditIntroDirectiveNode intro)

Class: EditDateRangeDirectiveNode   previous next package

Base class for a parse node that represents an EDIT body D SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditDateRangeDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditBodyDirectiveNode
Fields
The date format expected for the upper/lower bounds values.
public final com.arsi.mj.datatype.MaprptUsageDataType dateFormatType
Expression for lower bound of value, NULL if none.
public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr lowerBoundExpr
Expression for upper bound of value, NULL if none.
public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr upperBoundExpr
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
formatSpec - the expected format for the date bounds content
aLowerBoundExpr - the lower range bound as an expression; may be NULL
anUpperBoundExpr - the upper range bound as an expression; may be NULL
public EditDateRangeDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, com.arsi.mj.datatype.MaprptUsageDataType formatSpec, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr aLowerBoundExpr, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr anUpperBoundExpr)

Class: EditDateRangeDirectiveParser   previous next package

Parses the D sub-directive for the EDIT SC directive.
Treat this class as "thread-hostile"; instances should be created, used and discarded by single thread at a time.

Parsing Rules:


public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditDateRangeDirectiveParser
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParserBase
  implements com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser
Constructors
public EditDateRangeDirectiveParser()
Methods
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParseResult parseDirective(com.arsi.mj.maprpt.lexer.tokens.IMaprptToken anInitialToken, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveLexer aLexer, org.springframework.context.ApplicationContext anAppCtx)
    throws com.arsi.mj.MJTranslateException

Class: EditDynamicListDirectiveNode   previous next package

Base class for a parse node that represents an EDIT body RLOV SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditDynamicListDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditListOfValuesDirectiveNode
Fields
The source line type within the specified report.
public final com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr lineType
Source for values as a report/drawer/cabinet reference.
public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr rdcExpr
Valid values as bounds-style delineations.
public final java.util.List valueBounds
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
anOptionExpr - the option value provided; may be NULL
anRdcExpr - the Mapper report source coordinates
aLineType - the tpe for lines within the report to use as sources
someValueBounds - value column-and-length information provided to the RLOV directive; must never be NULL.
public EditDynamicListDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, com.arsi.mj.maprpt.lexer.ptree.expr.ICommandOptionExpr anOptionExpr, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr anRdcExpr, com.arsi.mj.maprpt.lexer.ptree.expr.IMaprptExpr aLineType, java.util.List someValueBounds)

Class: EditDynamicListDirectiveParser   previous next package

Parses the RLOV sub-directive for the EDIT SC directive.
Treat this class as "thread-hostile"; instances should be created, used and discarded by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditDynamicListDirectiveParser
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParserBase
  implements com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser
Constructors
public EditDynamicListDirectiveParser()
Methods
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParseResult parseDirective(com.arsi.mj.maprpt.lexer.tokens.IMaprptToken anInitialToken, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveLexer aLexer, org.springframework.context.ApplicationContext anAppCtx)
    throws com.arsi.mj.MJTranslateException

Class: EditFieldReference   previous next package

A field specification referenced in the EIDT intro node. A specification can be a single reference or a range expression.
public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference
  extends java.lang.Object
Inner Class EditReferenceType
Identifies the type of specification for post-compile processing.
public static final class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference.EditReferenceType
  extends java.lang.Enum
Indicates the specification cannot be determined at compile-time.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference.EditReferenceType INDETERMINATE

Indicates the specification is for a range of field numbers.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference.EditReferenceType RANGE

Indicates the specification only has a single reference.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference.EditReferenceType REFERENCE

public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference.EditReferenceType valueOf(java.lang.String name)
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference.EditReferenceType values()
Constructors
Initializes an instance of this class.
Parameters:
someExpressions - the expressions that define the specification
aType - the specification type
public EditFieldReference(java.util.List someExpressions, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference.EditReferenceType aType)
Methods
public java.util.List getExpressions()
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference.EditReferenceType getReferenceType()
public void setExpressions(java.util.List someExpressions)
public void setReferenceType(com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditFieldReference.EditReferenceType aType)

Class: EditIntegerRangeDirectiveNode   previous next package

Base class for a parse node that represents an EDIT body N SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditIntegerRangeDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditBodyDirectiveNode
Fields
Expression for lower bound of value known only at runtime, NULL if compile-time (or none).
public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr lowerBoundExpr
Literal lower bound of valid value known at compile time, NULL if run-time; if NULL and lowerBoundExpr also NULL, then no lower bound defined.
public final java.lang.Integer lowerBoundLiteral
Expression for upper bound of value known only at runtime, NULL if compile-time (or none).
public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr upperBoundExpr
Literal upper bound of valid value known at compile time, NULL if run-time; if NULL and upperBoundExpr also NULL, then no upper bound defined.
public final java.lang.Integer upperBoundLiteral
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
aLowerBoundExpr - the lower range bound as an expression; may be NULL
aLowerBoundLiteral - the lower range bound as a parsed literal value; may be NULL
anUpperBoundExpr - the upper range bound as an expression; may be NULL
anUpperBoundLiteral - the upper range bound as a parsed literal value; may be NULL
public EditIntegerRangeDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr aLowerBoundExpr, java.lang.Integer aLowerBoundLiteral, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr anUpperBoundExpr, java.lang.Integer anUpperBoundLiteral)

Class: EditIntegerRangeDirectiveParser   previous next package

Parses the N sub-directive for the EDIT SC directive.
Treat this class as "thread-hostile"; instances should be created, used and discarded by single thread at a time.

Parsing Rules:


public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditIntegerRangeDirectiveParser
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParserBase
  implements com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser
Constructors
public EditIntegerRangeDirectiveParser()
Methods
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParseResult parseDirective(com.arsi.mj.maprpt.lexer.tokens.IMaprptToken anInitialToken, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveLexer aLexer, org.springframework.context.ApplicationContext anAppCtx)
    throws com.arsi.mj.MJTranslateException

Class: EditIntroDirectiveNode   previous next package

Base class for a parse node that represents an EDIT intro SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditIntroDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveNode
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
someFieldReferences - the field(s) this edit directive applies to
protected EditIntroDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, java.util.List someFieldReferences)
Methods
public java.util.List getFieldReferences()

Class: EditIntroDirectiveParser   previous next package

Parses the intro sub-directive for the EDIT SC directive.
Treat this class as "thread-hostile"; instances should be created, used and discarded by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditIntroDirectiveParser
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParserBase
  implements com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser
Constructors
public EditIntroDirectiveParser()
Methods
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParseResult parseDirective(com.arsi.mj.maprpt.lexer.tokens.IMaprptToken anInitialToken, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveLexer aLexer, org.springframework.context.ApplicationContext anAppCtx)
    throws com.arsi.mj.MJTranslateException

Class: EditListOfValuesDirectiveNode   previous next package

Base class for a parse node that represents an EDIT body value list SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public abstract class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditListOfValuesDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditBodyDirectiveNode
Inner Class Option
Enumerated options for LOV sub-directive, associated with option letter or character. This class must implement that static method fromLetter for use with class CmdOptionConcatExpr.
public static final class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditListOfValuesDirectiveNode.Option
  extends java.lang.Enum
Indicates provided values are case-sensitive.
public static final com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditListOfValuesDirectiveNode.Option COLUMN_SEPARATOR

Looks up an instance by the match for the internal representation.
Parameters:
aChar - the character to match
Returns:
the matched option, or null if there is no match
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditListOfValuesDirectiveNode.Option fromLetter(char aChar)
Retrieves the internal representation.
Returns:
the corresponding character data
public char getLetter()
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditListOfValuesDirectiveNode.Option valueOf(java.lang.String name)
public static com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditListOfValuesDirectiveNode.Option values()
Fields
Option that indicates case sensitivity; null if values are to be case-insensitive.
public final com.arsi.mj.maprpt.lexer.ptree.expr.ICommandOptionExpr optionExpr
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
anOptionExpr - the option value provided; may be NULL
protected EditListOfValuesDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, com.arsi.mj.maprpt.lexer.ptree.expr.ICommandOptionExpr anOptionExpr)

Class: EditRequiredDirectiveNode   previous next package

Base class for a parse node that represents an EDIT body REQD SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditRequiredDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditBodyDirectiveNode
Fields
Field size as concatenation expression.
public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr sizeExpr
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
aSizeExpr - field size as concatenation expression from REQD directive; if REQD directive omits the count, a default is passed to this argument; must never be NULL.
public EditRequiredDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr aSizeExpr)

Class: EditRequiredDirectiveParser   previous next package

Parses the REQD sub-directive for the EDIT SC directive.
Treat this class as "thread-hostile"; instances should be created, used and discarded by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditRequiredDirectiveParser
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParserBase
  implements com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser
Constructors
public EditRequiredDirectiveParser()
Methods
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParseResult parseDirective(com.arsi.mj.maprpt.lexer.tokens.IMaprptToken anInitialToken, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveLexer aLexer, org.springframework.context.ApplicationContext anAppCtx)
    throws com.arsi.mj.MJTranslateException

Class: EditStaticListDirectiveNode   previous next package

Base class for a parse node that represents an EDIT body LOV SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditStaticListDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditListOfValuesDirectiveNode
Fields
Valid values as concatenation expressions.
public final java.util.List valueExprs
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
anOptionExpr - the option value provided; may be NULL
someValueExprs - values provided to the LOV directive; must never be NULL.
public EditStaticListDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, com.arsi.mj.maprpt.lexer.ptree.expr.ICommandOptionExpr anOptionExpr, java.util.List someValueExprs)

Class: EditStaticListDirectiveParser   previous next package

Parses the LOV sub-directive for the EDIT SC directive.
Treat this class as "thread-hostile"; instances should be created, used and discarded by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditStaticListDirectiveParser
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParserBase
  implements com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser
Constructors
public EditStaticListDirectiveParser()
Methods
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParseResult parseDirective(com.arsi.mj.maprpt.lexer.tokens.IMaprptToken anInitialToken, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveLexer aLexer, org.springframework.context.ApplicationContext anAppCtx)
    throws com.arsi.mj.MJTranslateException

Class: EditTimeRangeDirectiveNode   previous next package

Base class for a parse node that represents an EDIT body T SC directive.
Treat this class as "thread-hostile" since it holds substantial state without method synchronization; instances should only be used by single thread at a time.

public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditTimeRangeDirectiveNode
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditBodyDirectiveNode
Fields
Expression for lower bound of value, NULL if none.
public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr lowerBoundExpr
The date format expected for the upper/lower bounds values.
public final com.arsi.mj.datatype.MaprptUsageDataType timeFormatType
Expression for upper bound of value, NULL if none.
public final com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr upperBoundExpr
Constructors
Initializes an instance of this class.
Parameters:
aHostLine - Mapper report line that hosts this command
formatSpec - the expected format for the date bounds content
aLowerBoundExpr - the lower range bound as an expression; may be NULL
anUpperBoundExpr - the upper range bound as an expression; may be NULL
public EditTimeRangeDirectiveNode(com.arsi.mj.maprpt.parser.line.types.AtLine aHostLine, com.arsi.mj.datatype.MaprptUsageDataType formatSpec, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr aLowerBoundExpr, com.arsi.mj.maprpt.lexer.ptree.expr.ConcatExpr anUpperBoundExpr)

Class: EditTimeRangeDirectiveParser   previous package

Parses the T sub-directive for the EDIT SC directive.
Treat this class as "thread-hostile"; instances should be created, used and discarded by single thread at a time.

Parsing Rules:


public class com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.edit.EditTimeRangeDirectiveParser
  extends com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParserBase
  implements com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.IScDirectiveParser
Constructors
public EditTimeRangeDirectiveParser()
Methods
public com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveParseResult parseDirective(com.arsi.mj.maprpt.lexer.tokens.IMaprptToken anInitialToken, com.arsi.mj.maprpt.lexer.ptree.cmd.sc.directive.ScDirectiveLexer aLexer, org.springframework.context.ApplicationContext anAppCtx)
    throws com.arsi.mj.MJTranslateException