eu.bandm.music.demoMetric

Class Dm2Options

java.lang.Object

eu.bandm.tools.option.runtime.Model

eu.bandm.music.demoMetric.Dm2Options

public class Dm2Options
extends Model

Generated source for command line processing.
The parallel GUI class is GuiDm2Options.
The normal way of operation is:

1. Create a fresh instance by the only constructor Dm2Options().
2. Analyse command line by invoking Model.parse(String[],MessageReceiver)
3. Inquire whether a particular option X has been set on the commandline by invoking has_[X]().
4. 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.getMissingParams(), 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:

 ======
 USAGE:
 ======
 ----------------------------------------------------------
 Control batch operation for multiple metric split tests
 ----------------------------------------------------------
 --source         uri(="")
 Source file in "metric split batch file" format 
 
 

Created on 2020-11-15_12h23m32
by program bandm/metatools/option/compiler, version 2.1
command line =
bandm/metatools/option/compiler Dm2Options.xml eu.bandm.music.demoMetric Dm2Options GuiDm2Options $(HOME)/sig//src

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Dm2Options.Descriptions Programmatically generated catalog of translations.

Nested classes/interfaces inherited from class eu.bandm.tools.option.runtime.Model

Model.ExcDuplicate, Model.ExcFinish, Model.ExcNoData, Model.ExcNoData_allowed, Model.ExcUnknownOpt, Model.ExcWrongType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	has_source
protected java.lang.String	value_source_0

Fields inherited from class eu.bandm.tools.option.runtime.Model

boolresult, curOption, curParam, curParamGroup, descriptions, inputlength, inputstring, m_escapedBlanks, matcher, nextAbbrev, nextName, nextPToken, optTokenValid, p_escapedBlanks, p_hideblanks, p_option, p_param, parseErrorGenerator, positionalPhase, positionalsExplicit, positionalsFound, protocol

Constructor Summary

Constructors

Constructor and Description
Dm2Options()

Method Summary

Modifier and Type	Method and Description
protected void	_finalCheck()
java.lang.String	_getMissingParams()
protected void	checkActive()
java.lang.String	get_source_0() Getter method for the only argument of option source.
boolean	has_source() This option indicates: Source file in "metric split batch file" format.
Dm2Options	makeEmptyInstance()
protected void	parseAbbrev(java.lang.String select)
protected void	parseName(java.lang.String select)
protected void	parsePositionals()
java.lang.String	serialize()
void	usage_de() Print usage information in the language 'de'.
void	usage_en() Print usage information in the language 'en'.
void	usage() Print usage information in the default language.
void	usage(java.lang.String lang) Print usage information in the requested language.

Methods inherited from class eu.bandm.tools.option.runtime.Model

canReenterRepetitionGroup, descriptionKeyForCommentField, descriptionKeyForEnum, descriptionKeyForEnum, descriptionKeyForEnumItem, ERROR_plus, ERROR_UNKNOWN_ABBREV, ERROR_UNKNOWN_NAME, ERROR, getInputString, getMissingParams, getNextPToken, getOptToken, getParsingProtocol, lookForPToken, P_ERROR, parse, parseBool_optional, parseBool_X, parseBool, parseChar, parseEnum, parseEnumSet, parseFloat, parseInit, parseInt, parseOneString, parseOneUri, parseString, putprot_option, putprot, serialize, serialize, serialize, serialize, serialize, serialize, serialize, skipToOption, T_ERROR, unescapeBlanks, updateOptTokens, WARNING

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

has_source

protected boolean has_source

value_source_0

protected java.lang.String value_source_0

Constructor Detail

Dm2Options

public Dm2Options()

Method Detail

makeEmptyInstance

public Dm2Options makeEmptyInstance()

Specified by:

makeEmptyInstance in class Model

checkActive

protected void checkActive()

has_source

public boolean has_source()

This option indicates: Source file in "metric split batch file" format.

The format of this option on the command line is

 
        --source         uri(="")
 

To access the parameters of this option, please refer to the method(s) starting with get_source...

Returns:

whether the option has been set on the command line. (The result is of no significance when using GUI input.)

get_source_0

public java.lang.String get_source_0()

Getter method for the only argument of option source. For details of this option see the inquiry method has_source().

serialize

public java.lang.String serialize()

usage

public void usage()

Print usage information in the default language.

usage

public void usage(java.lang.String lang)

Print usage information in the requested language. Falls back to default language, if that language is not supported.

usage_de

public void usage_de()

Print usage information in the language 'de'.

usage_en

public void usage_en()

Print usage information in the language 'en'.

parseAbbrev

protected void parseAbbrev(java.lang.String select)

Specified by:

parseAbbrev in class Model

parseName

protected void parseName(java.lang.String select)

Specified by:

parseName in class Model

parsePositionals

protected void parsePositionals()

Specified by:

parsePositionals in class Model

_finalCheck

protected void _finalCheck()

Specified by:

_finalCheck in class Model

_getMissingParams

public java.lang.String _getMissingParams()

Specified by:

_getMissingParams in class Model