Main (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.d2d2.base.Main

```
public class Main
extends Object
```
This class implements the d2d2 comand line tool by main(String[]) and contains global static constants for d2d processing and for the d2d basic gp libraries. Most executives for the different tasks of d2d are dislocated as public static methods into Tasks, since they are also called by programs. See there for complete use case information flow diagrams.
Some transformations are implemeted in these both classes directly; others are implemented de-centrally. E.g. the reading of DTDs and .umod files as ddf-s is done by the ModuleRegistry "under the hood", when looking for text format definitions.
FIXME the "mode" parameter should better be called "task", or sim.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`debuglevel`
`static String`	`DEFAULT_LIBRARY`
`static String`	`DEFAULT_LIBRARY_SHORTCUT`
`static String`	`DEFAULT_XSLT_LIB`
`static String`	`filename_template_xslt_d2d`
`static String`	`filename_template_xslt_xml` Template for a pseudo file name for xslt rules extracted for one certain transformation task.
`protected Map<String,File>`	`formatsAndFiles`
`static String`	`generatedDocumentation_directoryName3`
`protected File`	`infile`
`protected String`	`inputname`
`protected Text2Udom.ErrorStrategy`	`interactiveErrorStrategy`
`protected Options.modes`	`mode`
`protected ModuleRegistry`	`moduleReg`
`protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>`	`msg`
`protected MessageCounter<SimpleMessage<XMLDocumentIdentifier>>`	`msg_counter`
`protected MessageReceiver<SimpleMessage<String>>`	`msgMEMSTRING`
`protected MessageReceiver<SimpleMessage<Object>>`	`msgNOLOC`
`protected static Options`	`options`
`protected File`	`outfile`
`protected String`	`outputname`
`protected FileOutputStream`	`outstream`
`static String`	`PROGRAM_NAME`
`static String`	`string_pseudo_format_xmlSource` The string which must be given as a "target format key" in the "keys" list of "text2texts()" for storing the un-processed xml data.
`static String`	`string_user_error_flag` The name of an xslt parameter which is SET automatically by this code to signal the presence of errors in preceding processing steps to subsequent xslt processing.
`static NamespaceName`	`stylesheet_param_cssUrls` Name of an xslt stylesheet parameter for processing it with Java code, in parallel to the usual xslt-based processing.
`static NamespaceName`	`stylesheet_param_favicon` Name of an xslt stylesheet parameter for processing it with Java code, in parallel to the usual xslt-based processing.
`static NamespaceName`	`stylesheet_param_preamble_filepos`
`protected NamespaceName2String`	`stylesheetParams`
`protected String`	`targetModule`
`protected String`	`targetTopTag`
`static String`	`url_default_ddfDoc_css`
`static String`	`VERSION`
`static String`	`VERSION_COMMENT`

Constructor Summary

Constructors
Constructor and Description

Main()

Constructors
Constructor and Description
`Main()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`check_multi_keys()` Parses the "keys" option, which contains pairs of target formats and file names.
`protected void`	`check_noKey_noKeys()`
`protected void`	`check_noKeys()`
`protected void`	`checkKeyIsSet(String txt)` currently only used for ddf2doc-mode
`protected void`	`closeoutstream()`
`protected void`	`error(Exception ex, String s)`
`protected void`	`error(String s)`
`protected void`	`get2names(String s)` Extract an input and an output file name from the options (option --source and --outputfile).
`protected void`	`getInputName()`
`protected void`	`getKey_split()` currently only used for ddf2xslt-mode.
`protected int`	`getLineWidth()`
`protected void`	`getStylesheetParams()`
`protected void`	`initInteractiveErrorStrategy()`
`protected void`	`initModuleReg()`
`protected void`	`initModuleReg(boolean useResolver34)`
`protected void`	`log(String s)`
`protected void`	`logEnd(String s)`
`protected void`	`logStart(String s)`
`static void`	`main(String[] args)`
`protected String`	`modeText()`
`protected void`	`nonStatic_main(String[] args)` Tool implementation: Decodes and checks the commandline options, sets up some global parameters and calls the different worker methods.
`protected void`	`openoutstream()`
`protected void`	`printErrorCounter()`
`static String[]`	`splitAndCheckKey(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, String s)` Split one string according to the syntax `[modulePath] (":"[ElementTag])?`.
`protected void`	`terminateApplicationOnErrors_printUsage()`
`protected void`	`terminateApplicationOnErrors()`
`protected void`	`warning(String s)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROGRAM_NAME

public static final String PROGRAM_NAME

See Also:: Constant Field Values

VERSION
```
public static final String VERSION
```
See Also:

Constant Field Values

VERSION_COMMENT

public static final String VERSION_COMMENT

See Also:: Constant Field Values

options
```
protected static final Options options
```

debuglevel
```
protected static int debuglevel
```

DEFAULT_LIBRARY

public static final String DEFAULT_LIBRARY

See Also:: Constant Field Values

DEFAULT_LIBRARY_SHORTCUT

public static final String DEFAULT_LIBRARY_SHORTCUT

See Also:: Constant Field Values

DEFAULT_XSLT_LIB

public static final String DEFAULT_XSLT_LIB

See Also:: Constant Field Values

string_pseudo_format_xmlSource
```
public static final String string_pseudo_format_xmlSource
```
The string which must be given as a "target format key" in the "keys" list of "text2texts()" for storing the un-processed xml data.

See Also:

Constant Field Values

string_user_error_flag
```
public static final String string_user_error_flag
```
The name of an xslt parameter which is SET automatically by this code to signal the presence of errors in preceding processing steps to subsequent xslt processing.

See Also:

Constant Field Values

filename_template_xslt_xml
```
public static final String filename_template_xslt_xml
```
Template for a pseudo file name for xslt rules extracted for one certain transformation task.

See Also:

Constant Field Values

filename_template_xslt_d2d

public static final String filename_template_xslt_d2d

See Also:: Constant Field Values

generatedDocumentation_directoryName3

public static final String generatedDocumentation_directoryName3

See Also:: Constant Field Values

url_default_ddfDoc_css

public static final String url_default_ddfDoc_css

See Also:: Constant Field Values

stylesheet_param_cssUrls
```
public static final NamespaceName stylesheet_param_cssUrls
```
Name of an xslt stylesheet parameter for processing it with Java code, in parallel to the usual xslt-based processing. Currently used in Ddf2Doc.

stylesheet_param_favicon
```
public static final NamespaceName stylesheet_param_favicon
```
Name of an xslt stylesheet parameter for processing it with Java code, in parallel to the usual xslt-based processing. Currently used in Ddf2Doc.

stylesheet_param_preamble_filepos

public static final NamespaceName stylesheet_param_preamble_filepos

inputname
```
protected String inputname
```

outputname
```
protected String outputname
```

infile
```
protected File infile
```

outfile
```
protected File outfile
```

outstream
```
protected FileOutputStream outstream
```

mode
```
protected Options.modes mode
```

targetModule
```
protected String targetModule
```

targetTopTag
```
protected String targetTopTag
```

formatsAndFiles

protected Map<String,File> formatsAndFiles

moduleReg
```
protected ModuleRegistry moduleReg
```

interactiveErrorStrategy

protected Text2Udom.ErrorStrategy interactiveErrorStrategy

stylesheetParams

protected NamespaceName2String stylesheetParams

msg_counter

protected MessageCounter<SimpleMessage<XMLDocumentIdentifier>> msg_counter

msg

protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg

msgNOLOC

protected MessageReceiver<SimpleMessage<Object>> msgNOLOC

msgMEMSTRING

protected MessageReceiver<SimpleMessage<String>> msgMEMSTRING

Constructor Detail
- Main
```
public Main()
```

Method Detail

error
```
protected void error(String s)
```

error

protected void error(Exception ex,
                     String s)

warning
```
protected void warning(String s)
```

log
```
protected void log(String s)
```

logStart
```
protected void logStart(String s)
```

logEnd
```
protected void logEnd(String s)
```

printErrorCounter
```
protected void printErrorCounter()
```

terminateApplicationOnErrors_printUsage

protected void terminateApplicationOnErrors_printUsage()

terminateApplicationOnErrors

protected void terminateApplicationOnErrors()

modeText
```
protected String modeText()
```

get2names
```
protected void get2names(String s)
```
Extract an input and an output file name from the options (option --source and --outputfile). Raise error if not possible. Currently use by: mode==text2xml / ddf2dtd / ddf2format / ddf2doc / ddf2xslt / ddf2htmlform / ddf2tsoap / dtd2ddf

getInputName
```
protected void getInputName()
```

check_noKey_noKeys
```
protected void check_noKey_noKeys()
```

check_noKeys
```
protected void check_noKeys()
```

splitAndCheckKey
```
public static String[] splitAndCheckKey(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
                                        String s)
```
Split one string according to the syntax [modulePath] (":"[ElementTag])?. Return one or two strings, or null in case of error. The first is always a definition module (mostly a dtd!). The second is the top-level element, used for identifying the "set of reachables".

getKey_split
```
protected void getKey_split()
```
currently only used for ddf2xslt-mode.

checkKeyIsSet
```
protected void checkKeyIsSet(String txt)
```
currently only used for ddf2doc-mode

check_multi_keys
```
protected void check_multi_keys()
```
Parses the "keys" option, which contains pairs of target formats and file names. Currently only used for "text2texts" mode.

getLineWidth
```
protected int getLineWidth()
```

openoutstream
```
protected void openoutstream()
```

closeoutstream
```
protected void closeoutstream()
```

initModuleReg
```
protected void initModuleReg()
```

initModuleReg

protected void initModuleReg(boolean useResolver34)

initInteractiveErrorStrategy

protected void initInteractiveErrorStrategy()

getStylesheetParams
```
protected void getStylesheetParams()
```

main

public static void main(String[] args)
                 throws Exception

Throws:: Exception

nonStatic_main
```
protected void nonStatic_main(String[] args)
                       throws Exception
```
Tool implementation: Decodes and checks the commandline options, sets up some global parameters and calls the different worker methods.

Throws:

Exception

Class Main

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROGRAM_NAME

VERSION

VERSION_COMMENT

options

debuglevel

DEFAULT_LIBRARY

DEFAULT_LIBRARY_SHORTCUT

DEFAULT_XSLT_LIB

string_pseudo_format_xmlSource

string_user_error_flag

filename_template_xslt_xml

filename_template_xslt_d2d

generatedDocumentation_directoryName3

url_default_ddfDoc_css

stylesheet_param_cssUrls

stylesheet_param_favicon

stylesheet_param_preamble_filepos

inputname

outputname

infile

outfile

outstream

mode

targetModule

targetTopTag

formatsAndFiles

moduleReg

interactiveErrorStrategy

stylesheetParams

msg_counter

msg

msgNOLOC

msgMEMSTRING

Constructor Detail

Main

Method Detail

error

error

warning

log

logStart

logEnd

printErrorCounter

terminateApplicationOnErrors_printUsage

terminateApplicationOnErrors

modeText

get2names

getInputName

check_noKey_noKeys

check_noKeys

splitAndCheckKey

getKey_split

checkKeyIsSet

check_multi_keys

getLineWidth

openoutstream

closeoutstream

initModuleReg

initModuleReg

initInteractiveErrorStrategy

getStylesheetParams

main

nonStatic_main