Package: com.arsi.mj.maprpt.parser.pragma.types
previous next contents
Package com.arsi.mj.maprpt.parser.pragma.types contains the following classes and interfaces.
| Classes and Interfaces |
| AssertDataTuplePragma |
Pragma that specifies that lines immediately following the pragma line be
recognized as tabular data lines, i.e., processed as tuples of data. |
| DefaultColumnNamesPragma |
Pragma that specifies default column names for the column masks in the
the asterisk line that immediately follows the pragma line. |
| IgnoreColumnHeadingPragma |
Pragma that specifies that column headings in asterisk lines that immediately
follow the pragma line are to be ignored, i.e., not processed as column headings.
|
| IgnoreDataTuplePragma |
Pragma that specifies that tabular data lines (e.g., tab lines) that immediately
follow the pragma line are to be ignored, i.e., not processed as tuples of data.
|
| IgnoreRunLinePragma |
Pragma that specifies that Mapper report lines that immediately follow the pragma
line are to be ignored when parsing a Mapper RUN control report. |
| UseInlineDataHandlerPragma |
Pragma that indicates which in-line data handler to use, where "in-line data" is
free form data (e.g., period or asterisk lines) that occurs in the midst of
columnar data (i.e., tab lines) in a Mapper report. |
Class: AssertDataTuplePragma
next
package
Pragma that specifies that lines immediately following the pragma line be
recognized as tabular data lines, i.e., processed as tuples of data. Useful
mostly when Mapper report content contains a large amount of mixed content
that prevents tabular data lines from being processed using default configuration
for a report.
The behavior of this pragma can be made conditional on a certain pass (e.g., "etl")
using the
APPLY_TO argument. Multiple lines can be asserted as data tuples
using the
EXPECTED_LINE_TYPE and
NUM_AFFECTED_LINES arguments;
if neither of these are present, the line immediately following the pragma is recognized
as tabular data.
Treat this class as "thread-hostile", since it is intended that instances of the
class be created, used and then discarded by a single thread.
| Constructors |
Public ctor for initializing an instance of this class.
- Parameters:
aName - name of pragma.
someArguments - arguments included in pragma directive, if any (may be an empty map).
aStandaloneFlag - does pragma occur on a line by itself?
public AssertDataTuplePragma(java.lang.String aName, java.util.Map someArguments, boolean aStandaloneFlag)
|
| Methods |
Get the pass that the pragma applies to, e.g., "etl", if any. If this
argument is not specified, the pragma is assumed to apply to all passes.
- Returns:
- the applicable pass (context specific), or NULL if none.
public java.lang.String getApplyTo()
|
Get the line type(s) that are expected to occur immediately after this pragma
that contain the in-line data. For example, if the expected line type is '^',
then one or more Mapper report lines that start with '^' are expected to
follow the pragma line, and are parsed as tuple data.
- Returns:
- a string that represents an array of line types, i.e., first characters
in a line, or NULL if no expected line types.
public java.lang.String getExpectedLineTypes()
|
Get the number of lines that are expected to occur immediately after this pragma
that contain the in-line data. For example, if the number of affected lines is 5,
then the five Mapper report lines following the pragma line are parsed as tuple data.
- Returns:
- the number of affected lines, or a negative number if none.
public int getNumberOfAffectedLines()
|
public boolean validate()
throws com.arsi.mj.MJTranslateException
|
Pragma that specifies default column names for the column masks in the
the asterisk line that immediately follows the pragma line. This pragma
does not override names present in asterisk lines that function
as column headings and occur immediately before the column mask line.
Instead, include the pragma only when an asterisk line containing column masks
occurs by itself (in this situation, without this pragma, the column masks
will be ignored).
Treat this class as "thread-hostile", since it is intended that instances of the
class be created, used and then discarded by a single thread.
| Fields |
Name of column names argument.
public static final java.lang.String NAMES_ARGNAME = "names"
|
| Constructors |
Public ctor for initializing an instance of this class.
- Parameters:
aName - name of pragma.
someArguments - arguments included in pragma directive, if any (may be an empty map).
aStandaloneFlag - does pragma occur on a line by itself?
public DefaultColumnNamesPragma(java.lang.String aName, java.util.Map someArguments, boolean aStandaloneFlag)
|
| Methods |
Get the default column names as a list of comma-delimited, possibly quoted tokens.
- Returns:
- list if column names, or empty list if none.
public java.util.List getColumnNames()
|
public boolean validate()
throws com.arsi.mj.MJTranslateException
|
Pragma that specifies that column headings in asterisk lines that immediately
follow the pragma line are to be ignored, i.e., not processed as column headings.
This behavior can be made conditional on a certain pass (e.g., "etl") using the
APPLY_TO argument.
Treat this class as "thread-hostile", since it is intended that instances of the
class be created, used and then discarded by a single thread.
| Fields |
Name of handler bean reference argument.
public static final java.lang.String HANDLER_BEAN_REF_ARGNAME = "handlerBeanRef"
|
| Constructors |
Public ctor for initializing an instance of this class.
- Parameters:
aName - name of pragma.
someArguments - arguments included in pragma directive, if any (may be an empty map).
aStandaloneFlag - does pragma occur on a line by itself?
public IgnoreColumnHeadingPragma(java.lang.String aName, java.util.Map someArguments, boolean aStandaloneFlag)
|
| Methods |
Get the pass that the pragma applies to, e.g., "etl", if any. If this
argument is not specified, the pragma is assumed to apply to all passes.
- Returns:
- the applicable pass (context specific), or NULL if none.
public java.lang.String getApplyTo()
|
public boolean validate()
throws com.arsi.mj.MJTranslateException
|
Pragma that specifies that tabular data lines (e.g., tab lines) that immediately
follow the pragma line are to be ignored, i.e., not processed as tuples of data.
This behavior can be made conditional on a certain pass (e.g., "etl") using the
APPLY_TO argument. Multiple lines can be ignored using the
EXPECTED_LINE_TYPE
and
NUM_AFFECTED_LINES arguments; if neither of these are present, the
line immediately following the pragma is ignored.
Treat this class as "thread-hostile", since it is intended that instances of the
class be created, used and then discarded by a single thread.
| Constructors |
Public ctor for initializing an instance of this class.
- Parameters:
aName - name of pragma.
someArguments - arguments included in pragma directive, if any (may be an empty map).
aStandaloneFlag - does pragma occur on a line by itself?
public IgnoreDataTuplePragma(java.lang.String aName, java.util.Map someArguments, boolean aStandaloneFlag)
|
| Methods |
Get the pass that the pragma applies to, e.g., "etl", if any. If this
argument is not specified, the pragma is assumed to apply to all passes.
- Returns:
- the applicable pass (context specific), or NULL if none.
public java.lang.String getApplyTo()
|
Get the line type(s) that are expected to occur immediately after this pragma
that contain the in-line data. For example, if the expected line type is '^',
then one or more Mapper report lines that start with '^' are expected to
follow the pragma line, and are ignored when parsing tuple data.
- Returns:
- a string that represents an array of line types, i.e., first characters
in a line, or NULL if no expected line types.
public java.lang.String getExpectedLineTypes()
|
Get the number of lines that are expected to occur immediately after this pragma
that contain the in-line data. For example, if the number of affected lines is 5,
then the five Mapper report lines following the pragma line are ignored when
parsing tuple data.
- Returns:
- the number of affected lines, or a negative number if none.
public int getNumberOfAffectedLines()
|
public boolean validate()
throws com.arsi.mj.MJTranslateException
|
Pragma that specifies that Mapper report lines that immediately follow the pragma
line are to be ignored when parsing a Mapper RUN control report. Multiple lines can
be ignored using the
EXPECTED_LINE_TYPE and
NUM_AFFECTED_LINES
arguments; if neither of these are present, the line immediately following the pragma
is ignored.
Treat this class as "thread-hostile", since it is intended that instances of the
class be created, used and then discarded by a single thread.
| Constructors |
Public ctor for initializing a default instance of this class.
public IgnoreRunLinePragma()
|
Public ctor for initializing an instance of this class.
- Parameters:
aName - name of pragma.
someArguments - arguments included in pragma directive, if any (may be an empty map).
aStandaloneFlag - does pragma occur on a line by itself?
public IgnoreRunLinePragma(java.lang.String aName, java.util.Map someArguments, boolean aStandaloneFlag)
|
| Methods |
Get the line type(s) that are expected to occur immediately after this pragma
that contain the in-line data. For example, if the expected line type is '^',
then one or more Mapper report lines that start with '^' are expected to
follow the pragma line, and are ignored.
- Returns:
- a string that represents an array of line types, i.e., first characters
in a line, or NULL if no expected line types.
public java.lang.String getExpectedLineTypes()
|
Get the number of lines that are expected to occur immediately after this pragma
that contain the in-line data. For example, if the number of affected lines is 5,
then the five Mapper report lines following the pragma line are ignored.
- Returns:
- the number of affected lines, or a negative number if none.
public int getNumberOfAffectedLines()
|
public boolean validate()
throws com.arsi.mj.MJTranslateException
|
Class: UseInlineDataHandlerPragma
previous
package
Pragma that indicates which in-line data handler to use, where "in-line data" is
free form data (e.g., period or asterisk lines) that occurs in the midst of
columnar data (i.e., tab lines) in a Mapper report. As the name applies, an
in-line data handler provides special handling for this kind of data.
Multiple lines can be denoted to use an in-line data handler using the
EXPECTED_LINE_TYPE and
NUM_AFFECTED_LINES arguments;
if neither of these are present, the line immediately following the pragma is
processed by the in-line data handler.
Treat this class as "thread-hostile", since it is intended that instances of the
class be created, used and then discarded by a single thread.
| Fields |
Name of handler bean reference argument.
public static final java.lang.String HANDLER_BEAN_REF_ARGNAME = "handlerBeanRef"
|
| Constructors |
Public ctor for initializing an instance of this class.
- Parameters:
aName - name of pragma.
someArguments - arguments included in pragma directive, if any (may be an empty map).
aStandaloneFlag - does pragma occur on a line by itself?
public UseInlineDataHandlerPragma(java.lang.String aName, java.util.Map someArguments, boolean aStandaloneFlag)
|
| Methods |
Get the line type(s) that are expected to occur immediately after this pragma
that contain the in-line data. For example, if the expected line type is '^',
then one or more Mapper report lines that start with '^' are expected to
follow the pragma line, and are treated as in-line data, and not tuple data.
- Returns:
- a string that represents an array of line types, i.e., first characters
in a line, or NULL if no expected line types.
public java.lang.String getExpectedLineTypes()
|
Get the reference to the bean that handles in-line data.
- Returns:
- the bean ID of the bean that handles in-line data. Returns NULL
if bean reference argument is missing, but the bean reference should
be treated as a required argument.
public java.lang.String getHandlerBeanReference()
|
Get the number of lines that are expected to occur immediately after this pragma
that contain the in-line data. For example, if the number of affected lines is 5,
then the five Mapper report lines following the pragma line are treated as in-line
data, and not tuple data.
- Returns:
- the number of affected lines, or a negative number if none.
public int getNumberOfAffectedLines()
|
public boolean validate()
throws com.arsi.mj.MJTranslateException
|