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

 

Package: com.arsi.mj.maprpt.parser.line.types  previous next contents

Package com.arsi.mj.maprpt.parser.line.types contains the following classes and interfaces.
Classes and Interfaces
AsteriskLine Class that represents an asterisk line in a Mapper report, i.e., column-formatted, non-edited data such as column headers (or metadata such as equations in the Mapper ICAL command) where the character in position 1 is an asterisk.
AtLine Class that represents a special "at" line in a Mapper report, i.e., RUN script statement(s) where the character in position 1 is an "at" sign.
ColonLine Class that represents a special "colon" line in a Mapper report, i.e., RUN constant declarations such as :define and :include, where the character in position 1 is a colon.
DollarLine Class that represents a special dollar-sign line in a Mapper report, i.e., control commands such as $TRAN$, $DATA$, etc. where the character in position 1 is a dollar sign.
MaprptLine Abstract base class that represents a line in a Mapper report.
OtherLine Class that represents a special line in a Mapper report where the character in line 1 is other than an asterisk, at-sign, dollar-sign, colon, period or tab.
PeriodLine Class that represents a period line in a Mapper report, i.e., free-form input such as comments where the character in position 1 is a period.
SpecialLine Base class that represents a special line in a Mapper report, e.g., RUN script statement, RUN constant definition, control command, etc. where the character in position 1 is something other than a tab, period or asterisk.
TabLine Class that represents a tab line in a Mapper report, i.e., column-formatted edited data such as tabular data where the character in position 1 is a tab.

Class: AsteriskLine   next package

Class that represents an asterisk line in a Mapper report, i.e., column-formatted, non-edited data such as column headers (or metadata such as equations in the Mapper ICAL command) where the character in position 1 is an asterisk.
Treat this class as "thread-compatible", since it is not designed out-of-the-box for multi-threaded use.
public class com.arsi.mj.maprpt.parser.line.types.AsteriskLine
  extends com.arsi.mj.maprpt.parser.line.types.MaprptLine
Inner Class ParsedColumnMask
Represents a column heading mask of equal signs that was parsed from an asterisk line (e.g., "====================").
public static class com.arsi.mj.maprpt.parser.line.types.AsteriskLine.ParsedColumnMask
  extends java.lang.Object
Get length of column mask.
Returns:
length of column mask.
public final int getLength()
Get position of column mask in entire source line (including first character), counting from zero.
Returns:
position of column mask.
public final int getPosition()
Get text of column mask, e.g., one or more equals signs.
Returns:
text of column mask.
public final java.lang.String getText()
Constructors
Restricted ctor for initializing an instance of this class.
Parameters:
aFirstChar - first character (the all-important position 1) of the source line, should be an asterisk in this case.
aSourceCode - source code for the Mapper report line.
aLineNumInfo - info about line number(s) in original Mapper report.
public AsteriskLine(java.lang.Character aFirstChar, java.lang.String aSourceCode, com.arsi.mj.maprpt.parser.line.LineNumberInfo aLineNumInfo)
Methods
Get column heading masks (e.g., "===========") parsed from this asterisk line, if any.
Returns:
list of columns parsed from the source line, or NULL if source was not recognized as containing column headings (e.g., source line contains a control character).
public final java.util.List getParsedColumnMasks()
Parse one or more column heading masks from a Mapper asterisk line, where a mask is one or more contiguous equal signs, and columns are separated by characters other than the equal sign.
Parameters:
aSourceLine - source code for the Mapper report line (excluding the first character, which is assumed to be an asterisk).
Returns:
list of column masks parsed from the source line, or NULL if source was not recognized as containing column masks.
public static java.util.List parseColumns(java.lang.String aSourceLine)

Class: AtLine   previous next package

Class that represents a special "at" line in a Mapper report, i.e., RUN script statement(s) where the character in position 1 is an "at" sign.
Treat this class as "thread-compatible", since it is not designed out-of-the-box for multi-threaded use.
public class com.arsi.mj.maprpt.parser.line.types.AtLine
  extends com.arsi.mj.maprpt.parser.line.types.SpecialLine
Constructors
Restricted ctor for initializing an instance of this class.
Parameters:
aFirstChar - first character (the all-important position 1) of the source line, should be an at-sign in this case.
aSourceCode - source code for the Mapper report line, including joined continuation lines.
aLineNumInfo - info about line number(s) in original Mapper report.
public AtLine(java.lang.Character aFirstChar, java.lang.String aSourceCode, com.arsi.mj.maprpt.parser.line.LineNumberInfo aLineNumInfo)

Class: ColonLine   previous next package

Class that represents a special "colon" line in a Mapper report, i.e., RUN constant declarations such as :define and :include, where the character in position 1 is a colon.
Treat this class as "thread-compatible", since it is not designed out-of-the-box for multi-threaded use.
public class com.arsi.mj.maprpt.parser.line.types.ColonLine
  extends com.arsi.mj.maprpt.parser.line.types.SpecialLine
Inner Class ContentType
A colon line may be part of the line table (":L"), a define statement (":DEFINE CONST1 abc"), child part of a DEFINE (": SUB1_CONST1 xyz"), INCLUDE statement (":include,16,b,5 ."), or, if none of these other types fit, textual content likely destined for the output area.
public static final class com.arsi.mj.maprpt.parser.line.types.ColonLine.ContentType
  extends java.lang.Enum
public static final com.arsi.mj.maprpt.parser.line.types.ColonLine.ContentType CHILD_DEFINE
public static final com.arsi.mj.maprpt.parser.line.types.ColonLine.ContentType DEFINE
public static final com.arsi.mj.maprpt.parser.line.types.ColonLine.ContentType INCLUDE
public static final com.arsi.mj.maprpt.parser.line.types.ColonLine.ContentType LINE_TABLE
public static final com.arsi.mj.maprpt.parser.line.types.ColonLine.ContentType TEXT
public static com.arsi.mj.maprpt.parser.line.types.ColonLine.ContentType valueOf(java.lang.String name)
public static com.arsi.mj.maprpt.parser.line.types.ColonLine.ContentType values()
Constructors
Restricted ctor for initializing an instance of this class.
Parameters:
aFirstChar - first character (the all-important position 1) of the source line, should be a colon in this case.
aSourceCode - source code for the Mapper report line.
aLineNumInfo - info about line number(s) in original Mapper report.
public ColonLine(java.lang.Character aFirstChar, java.lang.String aSourceCode, com.arsi.mj.maprpt.parser.line.LineNumberInfo aLineNumInfo)

Class: DollarLine   previous next package

Class that represents a special dollar-sign line in a Mapper report, i.e., control commands such as $TRAN$, $DATA$, etc. where the character in position 1 is a dollar sign.
Treat this class as "thread-compatible", since it is not designed out-of-the-box for multi-threaded use.
public class com.arsi.mj.maprpt.parser.line.types.DollarLine
  extends com.arsi.mj.maprpt.parser.line.types.SpecialLine
Constructors
Restricted ctor for initializing an instance of this class.
Parameters:
aFirstChar - first character (the all-important position 1) of the source line, should be a dollar sign in this case.
aSourceCode - source code for the Mapper report line.
aLineNumInfo - info about line number(s) in original Mapper report.
public DollarLine(java.lang.Character aFirstChar, java.lang.String aSourceCode, com.arsi.mj.maprpt.parser.line.LineNumberInfo aLineNumInfo)

Class: MaprptLine   previous next package

Abstract base class that represents a line in a Mapper report.
Treat this class as "thread-compatible", since it is not designed out-of-the-box for multi-threaded use.
public abstract class com.arsi.mj.maprpt.parser.line.types.MaprptLine
  extends java.lang.Object
Constructors
Restricted ctor for initializing an instance of this class.
Parameters:
aFirstChar - first character (the all-important position 1) of the source line.
aSourceCode - source code for the Mapper report line, including joined continuation lines but excluding the first character.
aLineNumInfo - info about line number(s) in input Mapper report.
protected MaprptLine(java.lang.Character aFirstChar, java.lang.String aSourceCode, com.arsi.mj.maprpt.parser.line.LineNumberInfo aLineNumInfo)
Methods
Get information about line number(s) in Mapper report for this source line that is best for diagnostic purposes (e.g., reporting an error at line so-and-so).
Returns:
line number alias or, if no line alias, the line number info.
public com.arsi.mj.maprpt.parser.line.LineNumberInfo diagnosticLineInfo()
Get the first character (the all-important position 1) of the source line.
Returns:
the first character of the source line.
public java.lang.Character getFirstCharacter()
Get information about line number(s) in original Mapper report for this source line, if any.
Returns:
line number alias or NULL if none.
public com.arsi.mj.maprpt.parser.line.LineNumberInfo getLineNumberAlias()
Get information about line number(s) in input Mapper report for this source line.
Returns:
line number information.
public com.arsi.mj.maprpt.parser.line.LineNumberInfo getLineNumberInfo()
Get pragmas that apply to the Mapper report line.
Returns:
list of pragmas that apply, or empty list if none.
public java.util.List getPragmas()
Get the source code for the Mapper report line, including joined continuation lines but excluding the first character.
Returns:
the source code for the line.
public java.lang.String getSourceCode()
Make and set aliased line number(s) that correlate to Mapper report where source line originated based on line number from original report. This works for code extracted from the original report. For example, if lines 10 to 12 are extracted as a code snippet from Mapper report 3B10 and parsed as lines 1 to 3 in the snippet, calling this method with the original line number 10 creates line number aliases of 10 through 12.
Parameters:
anOriginalLineNum - line number in original Mapper report.
public void makeLineNumberAlias(int anOriginalLineNum)
Set info about aliased line number(s) that correlate to Mapper report where source line originated (e.g., line is from a code snippet pulled from another report).
Parameters:
aLineNumInfo - info about line number(s) in original Mapper report.
public void setLineNumberAlias(com.arsi.mj.maprpt.parser.line.LineNumberInfo aLineNumInfo)
Set pragmas that apply to the Mapper report line.
Parameters:
somePragmas - pragmas that apply to Mapper report line.
public void setPragmas(java.util.List somePragmas)

Class: OtherLine   previous next package

Class that represents a special line in a Mapper report where the character in line 1 is other than an asterisk, at-sign, dollar-sign, colon, period or tab.
Treat this class as "thread-compatible", since it is not designed out-of-the-box for multi-threaded use.
public class com.arsi.mj.maprpt.parser.line.types.OtherLine
  extends com.arsi.mj.maprpt.parser.line.types.SpecialLine
Constructors
Restricted ctor for initializing an instance of this class.
Parameters:
aFirstChar - first character (the all-important position 1) of the source line, should be other than an asterisk, at-sign, dollar-sign, colon, period or tab in this case.
aSourceCode - source code for the Mapper report line.
aLineNumInfo - info about line number(s) in original Mapper report.
public OtherLine(java.lang.Character aFirstChar, java.lang.String aSourceCode, com.arsi.mj.maprpt.parser.line.LineNumberInfo aLineNumInfo)

Class: PeriodLine   previous next package

Class that represents a period line in a Mapper report, i.e., free-form input such as comments where the character in position 1 is a period.
Treat this class as "thread-compatible", since it is not designed out-of-the-box for multi-threaded use.
public class com.arsi.mj.maprpt.parser.line.types.PeriodLine
  extends com.arsi.mj.maprpt.parser.line.types.MaprptLine
Constructors
Restricted ctor for initializing an instance of this class.
Parameters:
aFirstChar - first character (the all-important position 1) of the source line, should be a period in this case.
aSourceCode - source code for the Mapper report line.
aLineNumInfo - info about line number(s) in original Mapper report.
public PeriodLine(java.lang.Character aFirstChar, java.lang.String aSourceCode, com.arsi.mj.maprpt.parser.line.LineNumberInfo aLineNumInfo)

Class: SpecialLine   previous next package

Base class that represents a special line in a Mapper report, e.g., RUN script statement, RUN constant definition, control command, etc. where the character in position 1 is something other than a tab, period or asterisk.
Treat this class as "thread-compatible", since it is not designed out-of-the-box for multi-threaded use.
public abstract class com.arsi.mj.maprpt.parser.line.types.SpecialLine
  extends com.arsi.mj.maprpt.parser.line.types.MaprptLine

Class: TabLine   previous package

Class that represents a tab line in a Mapper report, i.e., column-formatted edited data such as tabular data where the character in position 1 is a tab.
Treat this class as "thread-compatible", since it is not designed out-of-the-box for multi-threaded use.
public class com.arsi.mj.maprpt.parser.line.types.TabLine
  extends com.arsi.mj.maprpt.parser.line.types.MaprptLine
Constructors
Restricted ctor for initializing an instance of this class.
Parameters:
aFirstChar - first character (the all-important position 1) of the source line, should be a tab in this case.
aSourceCode - source code for the Mapper report line.
aLineNumInfo - info about line number(s) in original Mapper report.
public TabLine(java.lang.Character aFirstChar, java.lang.String aSourceCode, com.arsi.mj.maprpt.parser.line.LineNumberInfo aLineNumInfo)