Package eu.bandm.tools.d2d2.base

Class BatchOptions

java.lang.Object
eu.bandm.tools.option.runtime.Model<BatchOptions>
eu.bandm.tools.d2d2.base.BatchOptions
public class BatchOptions extends Model<BatchOptions>
Generated source for command line processing.
The parallel GUI class is BatchOptionsGui.
The normal way of operation is:
  1. Create a fresh instance by the only constructor BatchOptions().
  2. Analyse command line by invoking Model.parse(String[],MessageReceiver,String)
  3. Inquire whether a particular option X has been set on the commandline by invoking has_[X]().
  4. The arguments of each option are determined by a sequence of types: first a leading sequence, values for which appear exactly once, followed by a sequence which may be repeated. Both type sequences may be empty.
    Inquire value of the options n-th argument in the fixed, leading argument sequence by get_[X]_[n]().
  5. Inquire value of the options n-th argument in the k-th repetition group by get_[X]_[n](k).

If anything went wrong in parsing, errors have been sent to the MessageReceiver. Then further analysis methods can be applied (Model.getParsingProtocol(), Model.getMissingOptions(), Model.usage(), etc.)
For further details. please see the documentation of the methods inherited from the superclass Model and the option compiler's user documentation.

Here is the source text.

Internationalization

The documentation texts in the option definition file are multi-lingual. There are entries in the languages de and en.
As default language the English language has been chosen, because it is lingua franca of computer science.

The usage() method will show this screen: 

 ===================
 command line usage:
 ===================
 -v / --version        (bool)?(=true iff present)
 show application and version information
 -----------------------------
 main operation parameters:
 -----------------------------
 --path           ( string )+(="RES_eu.bandm.tools.doctypes.DocTypes/d2d_gp")
 where to look for type definition modules
 --sources        ( uri(="") )+
 path of source files to process, relative to common file base 
 --fileBase       uri(="")
 directory position as common prefix for all input and output files
 --inputPattern   string(="%")
 file name pattern to analyse the input files.
 --xmlResult      string(="")
 file name pattern where to store the xml version of the d2d inputs 
 --transformations  ( string(="") string(="") string(="") string(="") )*
 tuples of target name, tdom class names and top element (both possibly empty 
    = '-') and output file pattern.
 ----------------------------------
 output modification parameters:
 ----------------------------------
 --partialdocs    (bool)?(=true iff present)
 whether partially correct but incomplete documents may be produced.
 --stylesheetParams  ( string(="") string(="") )*
 parameters for an xslt style sheet processing.
 --stylesheetParamFiles  ( uri(="") )*
 list of files containing parameters for xslt processing.
 --tpathFunctions  string(="")
 name of a subclass of eu.bandm.tools.tpath.runtime.FunctionLibrary, defining 
    tpath functions. Defaults to tpath+xslt pre-defined functions.
 -------------------------------------
 operation modification parameters:
 -------------------------------------
 -d / --debug          int(=0)
 debug level, 0=silent 100=maximal verbose
 --interactive    int(=0)
 which info to print in case of error: (=1) stack situation (=2) generated 
    output so far 
 --strictCheck    boolean(=true)
 whether to type check unreachable code
 --pedantic       boolean(=true)
 whether to follow specification even when it appears hardly sensible 
 --noTxsl         (bool)?(=true iff present)
 do not use bandm txsl, but jre built-in xslt processor.
 --writeXsltFile  (bool)?(=true iff present)
 Write out intermediate files to disk (for debugging purpose) when collecting 
  xslt code.
 --txslTraceFlags  traceflag*(=EnumSet.noneOf(traceflag.class))
 sequence of flags which enable the different debug tracing separately
 --lineWidth      int(=70)
 width of a line for diverse print out procedures.
 
 traceflag:    Switch on/off different trace outputs individually.
 *           silent:  Suppress all log messages, even warnings. Print only 
 errors.
 *     justWarnings:  Suppress all log messages. Print errors and warnings. 
 (Overrides "silent")
 *     extendedInfo:  Print additional information with most messages.
 *       showSource:  Display source text as soon as parsed, and as additional
 information. 
 *     templateDirs:  Dump the template directories as soon they are filled.
 *     globalValues:  Trace calculation of all global values (parameters and 
 variables).
 *   resourceFinding:  Trace the resolution of URLs/URIs/file names and the 
 access to resource objets. 
 *   templateResolution:  Trace finding of templates. Includes xsl:for-each 
 application.
 *     templateCall:  Trace parameter set up and code executon start for 
 template calls and applies. 
 *        tpathEval:  Trace evaluation of all tpath expressions.
 *       tpathTypes:  Print the results of type checking tpath expressions.
 *   tpathFunctions:  Trace calls, parameters and results of functions called 
 from tpath expressions.
 *    varAssignment:  Trace assignments to variables.
 *    testDecisions:  Trace the deciding expressions in xsl:if and xsl:choose 
 expressions.
 *   exceptionStackTraces:  Print the java stack trace in case of exceptions.
 *   elementReducing:  Trace the reduce step of a collected result element, 
 ie. the call of the tdom semi-parser.
 *     verbatimText:  Dumps all verbatim inserted XML fragments.
Created on 2024-03-07_08h05m29
by program bandm/metatools/option/compiler, version 2.1
command line =
bandm/metatools/option/compiler batchOptions.xml eu.bandm.tools.d2d2.base BatchOptions BatchOptionsGui $(HOME)/metatools/src

  • Field Details

    • has_version

      protected boolean has_version

    • value_version_0

      protected boolean value_version_0

    • has_path

      protected boolean has_path

    • repvalues_path

      protected List<BatchOptions.Values_path> repvalues_path

    • serialize_path

      public final Function<BatchOptions.Values_path,String> serialize_path

    • has_sources

      protected boolean has_sources

    • repvalues_sources

      protected List<BatchOptions.Values_sources> repvalues_sources

    • serialize_sources

      public final Function<BatchOptions.Values_sources,String> serialize_sources

    • has_fileBase

      protected boolean has_fileBase

    • value_fileBase_0

      protected String value_fileBase_0

    • has_inputPattern

      protected boolean has_inputPattern

    • value_inputPattern_0

      protected String value_inputPattern_0

    • has_xmlResult

      protected boolean has_xmlResult

    • value_xmlResult_0

      protected String value_xmlResult_0

    • has_transformations

      protected boolean has_transformations

    • repvalues_transformations

      protected List<BatchOptions.Values_transformations> repvalues_transformations

    • serialize_transformations

      public final Function<BatchOptions.Values_transformations,String> serialize_transformations

    • has_partialdocs

      protected boolean has_partialdocs

    • value_partialdocs_0

      protected boolean value_partialdocs_0

    • has_stylesheetParams

      protected boolean has_stylesheetParams

    • repvalues_stylesheetParams

      protected List<BatchOptions.Values_stylesheetParams> repvalues_stylesheetParams

    • serialize_stylesheetParams

      public final Function<BatchOptions.Values_stylesheetParams,String> serialize_stylesheetParams

    • has_stylesheetParamFiles

      protected boolean has_stylesheetParamFiles

    • repvalues_stylesheetParamFiles

      protected List<BatchOptions.Values_stylesheetParamFiles> repvalues_stylesheetParamFiles

    • serialize_stylesheetParamFiles

      public final Function<BatchOptions.Values_stylesheetParamFiles,String> serialize_stylesheetParamFiles

    • has_tpathFunctions

      protected boolean has_tpathFunctions

    • value_tpathFunctions_0

      protected String value_tpathFunctions_0

    • has_debug

      protected boolean has_debug

    • value_debug_0

      protected int value_debug_0

    • has_interactive

      protected boolean has_interactive

    • value_interactive_0

      protected int value_interactive_0

    • has_strictCheck

      protected boolean has_strictCheck

    • value_strictCheck_0

      protected boolean value_strictCheck_0

    • has_pedantic

      protected boolean has_pedantic

    • value_pedantic_0

      protected boolean value_pedantic_0

    • has_noTxsl

      protected boolean has_noTxsl

    • value_noTxsl_0

      protected boolean value_noTxsl_0

    • has_writeXsltFile

      protected boolean has_writeXsltFile

    • value_writeXsltFile_0

      protected boolean value_writeXsltFile_0

    • has_txslTraceFlags

      protected boolean has_txslTraceFlags

    • value_txslTraceFlags_0

      protected EnumSet<BatchOptions.traceflag> value_txslTraceFlags_0

    • has_lineWidth

      protected boolean has_lineWidth

    • value_lineWidth_0

      protected int value_lineWidth_0

  • Constructor Details

    • BatchOptions

      public BatchOptions()

  • Method Details

    • makeDefaultInstance

      public BatchOptions makeDefaultInstance()
      Description copied from class: Model
      Overriden by the generated code to make a constructor call of the actual Model (sub-)class.
      Specified by:
      makeDefaultInstance in class Model<BatchOptions>

    • checkActive

      protected void checkActive()
      Description copied from class: Model
      The generated code will evaluate all conditions to activate/deactive options in the GUI.
      Specified by:
      checkActive in class Model<BatchOptions>

    • has_version

      @Deprecated public boolean has_version()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_version_0().

    • get_version_0

      public boolean get_version_0()
      Getter method for the 0th argument of option version.
      This option indicates: show application and version information.

      The format of this option on the command line is 
       
   -v / --version        (bool)?(=true iff present)

    • has_path

      @Deprecated public boolean has_path()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_path().

    • get_path

      public List<BatchOptions.Values_path> get_path()
      Getter method for all repetition groups of option path.
      This option indicates: where to look for type definition modules.

      The format of this option on the command line is 
       
        --path           ( string )+(="RES_eu.bandm.tools.doctypes.DocTypes/d2d_gp")

    • get_path_0

      public String get_path_0(int index)
      Getter method for the only repeated argument of option path. For details of this option see the method get_path().
      Parameters:
      index - the index of the repetition group, zero based.

    • has_sources

      @Deprecated public boolean has_sources()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_sources().

    • get_sources

      public List<BatchOptions.Values_sources> get_sources()
      Getter method for all repetition groups of option sources.
      This option indicates: path of source files to process, relative to common file base.

      The format of this option on the command line is 
       
        --sources        ( uri(="") )+

    • get_sources_0

      public String get_sources_0(int index)
      Getter method for the only repeated argument of option sources. For details of this option see the method get_sources().
      Parameters:
      index - the index of the repetition group, zero based.

    • has_fileBase

      @Deprecated public boolean has_fileBase()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_fileBase_0().

    • get_fileBase_0

      public String get_fileBase_0()
      Getter method for the only argument of option fileBase.
      This option indicates: directory position as common prefix for all input and output files.

      The format of this option on the command line is 
       
        --fileBase       uri(="")

    • has_inputPattern

      @Deprecated public boolean has_inputPattern()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_inputPattern_0().

    • get_inputPattern_0

      public String get_inputPattern_0()
      Getter method for the only argument of option inputPattern.
      This option indicates: file name pattern to analyse the input files.

      The format of this option on the command line is 
       
        --inputPattern   string(="%")

    • has_xmlResult

      @Deprecated public boolean has_xmlResult()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_xmlResult_0().

    • get_xmlResult_0

      public String get_xmlResult_0()
      Getter method for the only argument of option xmlResult.
      This option indicates: file name pattern where to store the xml version of the d2d inputs.

      The format of this option on the command line is 
       
        --xmlResult      string(="")

    • has_transformations

      @Deprecated public boolean has_transformations()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_transformations().

    • get_transformations

      public List<BatchOptions.Values_transformations> get_transformations()
      Getter method for all repetition groups of option transformations.
      This option indicates: tuples of target name, tdom class names and top element (both possibly empty = '-') and output file pattern.

      The format of this option on the command line is 
       
        --transformations  ( string(="") string(="") string(="") string(="") )*

    • get_transformations_0

      public String get_transformations_0(int index)
      Getter method for the 0th in a group of repeated arguments of option transformations. For details of this option see the method get_transformations().
      Parameters:
      index - the index of the repetition group, zero based.

    • get_transformations_1

      public String get_transformations_1(int index)
      Getter method for the 1st in a group of repeated arguments of option transformations. For details of this option see the method get_transformations().
      Parameters:
      index - the index of the repetition group, zero based.

    • get_transformations_2

      public String get_transformations_2(int index)
      Getter method for the 2nd in a group of repeated arguments of option transformations. For details of this option see the method get_transformations().
      Parameters:
      index - the index of the repetition group, zero based.

    • get_transformations_3

      public String get_transformations_3(int index)
      Getter method for the 3rd in a group of repeated arguments of option transformations. For details of this option see the method get_transformations().
      Parameters:
      index - the index of the repetition group, zero based.

    • has_partialdocs

      @Deprecated public boolean has_partialdocs()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_partialdocs_0().

    • get_partialdocs_0

      public boolean get_partialdocs_0()
      Getter method for the 0th argument of option partialdocs.
      This option indicates: whether partially correct but incomplete documents may be produced.

      The format of this option on the command line is 
       
        --partialdocs    (bool)?(=true iff present)

    • has_stylesheetParams

      @Deprecated public boolean has_stylesheetParams()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_stylesheetParams().

    • get_stylesheetParams

      public List<BatchOptions.Values_stylesheetParams> get_stylesheetParams()
      Getter method for all repetition groups of option stylesheetParams.
      This option indicates: parameters for an xslt style sheet processing.

      The format of this option on the command line is 
       
        --stylesheetParams  ( string(="") string(="") )*

    • get_stylesheetParams_0

      public String get_stylesheetParams_0(int index)
      Getter method for the 0th in a group of repeated arguments of option stylesheetParams. For details of this option see the method get_stylesheetParams().
      Parameters:
      index - the index of the repetition group, zero based.

    • get_stylesheetParams_1

      public String get_stylesheetParams_1(int index)
      Getter method for the 1st in a group of repeated arguments of option stylesheetParams. For details of this option see the method get_stylesheetParams().
      Parameters:
      index - the index of the repetition group, zero based.

    • has_stylesheetParamFiles

      @Deprecated public boolean has_stylesheetParamFiles()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_stylesheetParamFiles().

    • get_stylesheetParamFiles

      public List<BatchOptions.Values_stylesheetParamFiles> get_stylesheetParamFiles()
      Getter method for all repetition groups of option stylesheetParamFiles.
      This option indicates: list of files containing parameters for xslt processing.

      The format of this option on the command line is 
       
        --stylesheetParamFiles  ( uri(="") )*

    • get_stylesheetParamFiles_0

      public String get_stylesheetParamFiles_0(int index)
      Getter method for the only repeated argument of option stylesheetParamFiles. For details of this option see the method get_stylesheetParamFiles().
      Parameters:
      index - the index of the repetition group, zero based.

    • has_tpathFunctions

      @Deprecated public boolean has_tpathFunctions()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_tpathFunctions_0().

    • get_tpathFunctions_0

      public String get_tpathFunctions_0()
      Getter method for the only argument of option tpathFunctions.
      This option indicates: name of a subclass of eu.bandm.tools.tpath.runtime.FunctionLibrary, defining tpath functions. Defaults to tpath+xslt pre-defined functions.

      The format of this option on the command line is 
       
        --tpathFunctions  string(="")

    • has_debug

      @Deprecated public boolean has_debug()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_debug_0().

    • get_debug_0

      public int get_debug_0()
      Getter method for the only argument of option debug.
      This option indicates: debug level, 0=silent 100=maximal verbose.

      The format of this option on the command line is 
       
   -d / --debug          int(=0)

    • has_interactive

      @Deprecated public boolean has_interactive()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_interactive_0().

    • get_interactive_0

      public int get_interactive_0()
      Getter method for the only argument of option interactive.
      This option indicates: which info to print in case of error: (=1) stack situation (=2) generated output so far.

      The format of this option on the command line is 
       
        --interactive    int(=0)

    • has_strictCheck

      @Deprecated public boolean has_strictCheck()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_strictCheck_0().

    • get_strictCheck_0

      public boolean get_strictCheck_0()
      Getter method for the only argument of option strictCheck.
      This option indicates: whether to type check unreachable code.

      The format of this option on the command line is 
       
        --strictCheck    boolean(=true)

    • has_pedantic

      @Deprecated public boolean has_pedantic()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_pedantic_0().

    • get_pedantic_0

      public boolean get_pedantic_0()
      Getter method for the only argument of option pedantic.
      This option indicates: whether to follow specification even when it appears hardly sensible.

      The format of this option on the command line is 
       
        --pedantic       boolean(=true)

    • has_noTxsl

      @Deprecated public boolean has_noTxsl()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_noTxsl_0().

    • get_noTxsl_0

      public boolean get_noTxsl_0()
      Getter method for the only argument of option noTxsl.
      This option indicates: do not use bandm txsl, but jre built-in xslt processor.

      The format of this option on the command line is 
       
        --noTxsl         (bool)?(=true iff present)

    • has_writeXsltFile

      @Deprecated public boolean has_writeXsltFile()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_writeXsltFile_0().

    • get_writeXsltFile_0

      public boolean get_writeXsltFile_0()
      Getter method for the 0th argument of option writeXsltFile.
      This option indicates: Write out intermediate files to disk (for debugging purpose) when collecting xslt code.

      The format of this option on the command line is 
       
        --writeXsltFile  (bool)?(=true iff present)

    • has_txslTraceFlags

      @Deprecated public boolean has_txslTraceFlags()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_txslTraceFlags_0().

    • get_txslTraceFlags_0

      public EnumSet<BatchOptions.traceflag> get_txslTraceFlags_0()
      Getter method for the only argument of option txslTraceFlags.
      This option indicates: sequence of flags which enable the different debug tracing separately.

      The format of this option on the command line is 
       
        --txslTraceFlags  traceflag*(=EnumSet.noneOf(traceflag.class))

    • has_lineWidth

      @Deprecated public boolean has_lineWidth()
      Deprecated.
      Returns:
      whether the option has been set on the command line. (The result is of no significance when using GUI input, and should neither be used in command line mode.) For details of this option see the method get_lineWidth_0().

    • get_lineWidth_0

      public int get_lineWidth_0()
      Getter method for the only argument of option lineWidth.
      This option indicates: width of a line for diverse print out procedures.

      The format of this option on the command line is 
       
        --lineWidth      int(=70)

    • serialize

      public String serialize()
      Description copied from class: Model
      Called to generate a String representation of the model's state. Code is overridden by the compiled code.
      Specified by:
      serialize in class Model<BatchOptions>

    • usage

      public void usage(PrintStream pr)
      Print usage information in the default language.
      Specified by:
      usage in class Model<BatchOptions>

    • usage

      public void usage(PrintStream pr, String lang)
      Print usage information in the requested language. Falls back to default language, if that language is not supported.
      Specified by:
      usage in class Model<BatchOptions>

    • usage_de

      public void usage_de()
      Print usage information in the language 'de' on System.err.

    • usage_de

      public void usage_de(PrintStream pr)
      Print usage information in the language 'de'.

    • usage_en

      public void usage_en()
      Print usage information in the language 'en' on System.err.

    • usage_en

      public void usage_en(PrintStream pr)
      Print usage information in the language 'en'.

    • parseAbbrev

      protected void parseAbbrev(String select)
      Description copied from class: Model
      Callback, overridden by compiled code, which realizes a switch over all one character option names. The generated code calls the argument parsers and stores the resulting values to the model's fields.
      Specified by:
      parseAbbrev in class Model<BatchOptions>
      Parameters:
      select - the one-character option name, as parsed by this code.

    • parseName

      protected void parseName(String select)
      Description copied from class: Model
      Callback, overridden by compiled code, which realizes a switch over all long option names. The generated code calls the argument parsers and stores the resulting values to the model's fields.
      Specified by:
      parseName in class Model<BatchOptions>
      Parameters:
      select - the multi-character option name, as parsed by this code.

    • numberOfPositionals

      protected int numberOfPositionals()
      Description copied from class: Model
      The generated code will return the number of positional parameters.
      Specified by:
      numberOfPositionals in class Model<BatchOptions>

    • parsePositionals

      protected void parsePositionals()
      Description copied from class: Model
      Callback, overridden by compiled code, which calls one after the other the positional parameters. Each of them corresponds to an implicit option (with short names "-0", "-1", "-2", ...). These can also be defined explicitly, e.g. be given a long name, etc. Anyhow, they can be set explicitly by their short name. If one single positional option is given explicitly, the implicit parsing of the others is suppressed and this code will not be called.
      Specified by:
      parsePositionals in class Model<BatchOptions>

    • _finalCheck

      protected void _finalCheck()
      Description copied from class: Model
      Callback, overridden by compiled code.
      Specified by:
      _finalCheck in class Model<BatchOptions>

    • _getMissingOptions

      public String _getMissingOptions()
      Description copied from class: Model
      Is overridden in the generated code and concatenates the "longest names" of all otions marked as required, but not present in the parsed input. Length==0 iff none is missing. Cf "sourcedtd required='yes'" in tools/tdom_withOptions/Options.xml
      Specified by:
      _getMissingOptions in class Model<BatchOptions>

    • _getRedundantOptions

      public String _getRedundantOptions()
      Description copied from class: Model
      Callback, overridden by compiled code.
      Specified by:
      _getRedundantOptions in class Model<BatchOptions>