Batch (BandM metatools API doc)

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

```
public class Batch
extends Object
```
Batch processing of d2d sources into different back-ends, using BandMs' own "txsl" implementation of xslt 1_0. Realizes more efficient processing of more than one input file into more than one output format without module caching, since the start-up phase must only be executed once. For this special task, it is an alternative to Main and to Webstart.
Currently only one(1) set of style-sheet parameters can be given, for all transformations. (This could be extended in future versions.)
Central executive is nonStatic_main(String[]).

This is a new source, combining elements from d2d2/base/Main, d2d2/base/Tasks and xslt/base/Main.

FIXME NOT YET OPERATIVE.
NOT YET IN "ect/callTools.mk"

FIXME REMOVE touched files in case of error !

FIXME factor out common code from (a) here, (b)xslt Main, (c) Tasks.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`debuglevel`
`static String`	`filename_template_transformations`
`static String`	`filenameStemPlaceholder`
`protected Text2Udom.ErrorStrategy`	`interactiveErrorStrategy`
`protected ModuleRegistry`	`moduleRegistry`
`protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>`	`msg`
`protected MessageCounter<SimpleMessage<XMLDocumentIdentifier>>`	`msg_counter`
`protected BatchOptions`	`options`
`protected NamespaceName2String`	`stylesheetParams`

Constructor Summary

Constructors
Constructor and Description

Batch()

Constructors
Constructor and Description
`Batch()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected EnumSet<Options.traceflag>`	`convert(EnumSet<BatchOptions.traceflag> set)` Convert an enum set of trace flags defined HERE to a set of xslt flags, identified by NAME.
`protected @Opt Transformation`	`do_loadTransformationForModule(ResolvedModule mod, int pos)`
`protected void`	`error(Exception ex, String s)`
`protected void`	`error(Exception ex, String s, Object... args)`
`protected void`	`error(String s)`
`protected void`	`error(String s, Object... args)`
`protected void`	`failure(String s)`
`protected int`	`getLineWidth()`
`protected void`	`getStylesheetParams()` First put all param file names, than the explicit parameters from the command line, with higher priority. FIXME abstract + unify with xslt/base/Main
`protected void`	`initInteractiveErrorStrategy()`
`protected void`	`initModuleReg()`
`protected @Opt Transformation`	`loadTransformationForModule(ResolvedModule mod, int pos)`
`protected void`	`log(String s)`
`protected void`	`logEnd(String s)`
`protected void`	`logStart(String s)`
`static void`	`main(String[] args)`
`protected void`	`nonStatic_main(String[] args)` Central command line processing method.
`protected void`	`printErrorCounter()`
`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
  - filenameStemPlaceholder
```
public static final String filenameStemPlaceholder
```
    See Also:
    
    Constant Field Values
  - filename_template_transformations
```
public static final String filename_template_transformations
```
    See Also:
    
    Constant Field Values
  - moduleRegistry
```
protected ModuleRegistry moduleRegistry
```
  - interactiveErrorStrategy
```
protected Text2Udom.ErrorStrategy interactiveErrorStrategy
```
  - stylesheetParams
```
protected NamespaceName2String stylesheetParams
```
  - options
```
protected final BatchOptions options
```
  - debuglevel
```
protected int debuglevel
```
  - msg_counter
```
protected MessageCounter<SimpleMessage<XMLDocumentIdentifier>> msg_counter
```
  - msg
```
protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg
```
- Constructor Detail
  - Batch
```
public Batch()
```
- Method Detail
  - error
```
protected void error(String s,
                     Object... args)
```
  - error
```
protected void error(Exception ex,
                     String s,
                     Object... args)
```
  - error
```
protected void error(String s)
```
  - failure
```
protected void failure(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()
```
  - getLineWidth
```
protected int getLineWidth()
```
  - initModuleReg
```
protected void initModuleReg()
```
  - initInteractiveErrorStrategy
```
protected void initInteractiveErrorStrategy()
```
  - getStylesheetParams
```
protected void getStylesheetParams()
```
    First put all param file names, than the explicit parameters from the command line, with higher priority.
    FIXME abstract + unify with xslt/base/Main
  - convert
```
protected EnumSet<Options.traceflag> convert(EnumSet<BatchOptions.traceflag> set)
```
    Convert an enum set of trace flags defined HERE to a set of xslt flags, identified by NAME.
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception
  - nonStatic_main
```
protected void nonStatic_main(String[] args)
                       throws Exception
```
    Central command line processing method. The command line parameters are defined by BatchOptions. The processing uses the metatoos xslt 1.0 implementation "txsl", and the options INCLUDE also all txsl options.
    Stylesheet parameters can be given a sequence of style sheet parameter files, and one by one on the command line, with increasing priority.
    The character filenameStemPlaceholder can be used in these parameter values and will be replaced by the file name stem currently processed.
    One single call converts "k" source files into "m" output files using xslt, plus possibly the pure ".xml" version. This produces "k*m" or "k*(m+1)" output files, while all preparatory module loading, xslt compiling, etc. is performed only once.
    The naming scheme is as follows: A "stem" is extracted from all sources, and combined with all target formats to construct the output file name, in the same way as "make" does. The placeholder character can also appear in style sheet parameter values, and will also be replaced by the stem.
    If only one source is given, then the output files (xml and transformation results) need not contain a placeholder. The input pattern must be given anyhow, because the stem may be requested in a style sheet parameter value.
    
    Throws:
    
    Exception
  - loadTransformationForModule
```
@Opt
protected @Opt Transformation loadTransformationForModule(ResolvedModule mod,
                                                               int pos)
```
    Parameters:
    
    mod - resolved module containing the definition of the top-most element to translate
    
    int - position in the command line list of transformations
    
    Returns:
    
    null in case of error (signalled now or already earlier)
  - do_loadTransformationForModule
```
@Opt
protected @Opt Transformation do_loadTransformationForModule(ResolvedModule mod,
                                                                  int pos)
```
    Returns:
    
    null in case of error

Class Batch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

filenameStemPlaceholder

filename_template_transformations

moduleRegistry

interactiveErrorStrategy

stylesheetParams

options

debuglevel

msg_counter

msg

Constructor Detail

Batch

Method Detail

error

error

error

failure

error

warning

log

logStart

logEnd

printErrorCounter

terminateApplicationOnErrors_printUsage

terminateApplicationOnErrors

getLineWidth

initModuleReg

initInteractiveErrorStrategy

getStylesheetParams

convert

main

nonStatic_main

loadTransformationForModule

do_loadTransformationForModule