cb.jdynamite.tool

Class JDynTool

java.lang.Object

cb.jdynamite.tool.JDynTool

public class JDynTool
extends java.lang.Object

JDynTool is a tool which is based on JDynamiTe, allowing to use JDynamiTe template files by two very simple ways:
- by command line invocation: no java code is needed,
- or by JDynTool "run" method call: only few lines of code in your java application.

1) Command line invocation

See main(String[]) usage.

2) Programmatic invocation

Typical instructions sequence in your Java code:

1. Create a JDynTool object.


2. For the first call: you have to specify the "JDynamiTe input Template file" in addition to other parameters.
So, call either run(String, String, Hashtable, boolean) method,
or run(InputStream, String, Hashtable, boolean) method.


3. For the subsequent calls (if any):
You can call the second run(String, Hashtable, boolean) method, which will reuse the same template (previously loaded).


4. Then call JDynamiTe.toString() method on the JDynamiTe returned object to get the parsing result (i.e. the populated output document).

Dependencies:
In addition to JDynamiTe classes, JDynTool requires "java-getopt-1.0.14.jar", included in JDynamiTe distribution.
"java-getopt" is a Java port of GNU getopt, provided by Aaron M. Renn (thanks to him and to developers who support this package).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INPUT_TEMPLATE_PATH_VAR_TAG Special variable tag, {__INPUT_TEMPLATE__}, that you can use in your template, and which is automatically populated with the JDynamiTe input file path string.

Constructor Summary

Constructors

Constructor and Description
JDynTool() Creates a JDynTool object and its associated JDynamiTe object.

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(java.lang.String[] args)
JDynamiTe	run(java.io.InputStream inputStreamTemplateFile, java.lang.String defaultRootXMLInputDoc, java.util.Hashtable<java.lang.String,java.lang.String> keyValuesList, boolean verbose) Reads, analyses and processes the input template file and then produces the output result.
JDynamiTe	run(java.lang.String defaultRootXMLInputDoc, java.util.Hashtable<java.lang.String,java.lang.String> keyValuesList, boolean verbose) Processes the input template file and then produces the output result.
JDynamiTe	run(java.lang.String inputTemplateFile, java.lang.String defaultRootXMLInputDoc, java.util.Hashtable<java.lang.String,java.lang.String> keyValuesList, boolean verbose) Reads, analyses and processes the input template file and then produces the output result.

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_TEMPLATE_PATH_VAR_TAG

public static final java.lang.String INPUT_TEMPLATE_PATH_VAR_TAG

Special variable tag, {__INPUT_TEMPLATE__}, that you can use in your template, and which is automatically populated with the JDynamiTe input file path string.

See Also:

Constant Field Values

Constructor Detail

JDynTool

public JDynTool()

Creates a JDynTool object and its associated JDynamiTe object. This JDynTool object is then used to call its run(String, String, Hashtable, boolean) method.

See Also:

run(String, String, Hashtable, boolean)

Method Detail

run

public JDynamiTe run(java.lang.String inputTemplateFile,
            java.lang.String defaultRootXMLInputDoc,
            java.util.Hashtable<java.lang.String,java.lang.String> keyValuesList,
            boolean verbose)

Reads, analyses and processes the input template file and then produces the output result. This method uses a JDynamiTe object to process the input template file and then produce the output result.
The global process of this method consists in:
1) processing all "simple" JDynamiTe Variables, by calling JDynamiTe.setVariable(String, String) method for each key-value pair.
2) processing recursively all XML Dynamic blocks, by calling the JDynamiTe.parseXMLDynElem() method.

Parameters:

inputTemplateFile - Input template file path. This path will be used to call the JDynamiTe.setInput(String) method.

defaultRootXMLInputDoc - Default URI for first level XML dynamic block(s) which do not have an URI in their definition in template file. This optional parameter can be null.

keyValuesList - List of key-value pairs used to set values to the JDynamiTe variables contained in the input template. Each key-value pair will be passed to the JDynamiTe.setVariable(String, String) method.

verbose - If true, print on stderr output some information messages during document processing.

Returns:

If the inputTemplateFile can be read and analysed, this method returns the JDynamiTe object used to process the template document.
Use then the JDynamiTe.toString() method on this returned object to get the parsing result (i.e. the populated output document).
If the inputTemplateFile is undefined or can not be read, this method returns null.

See Also:

JDynamiTe.setInput(String), JDynamiTe.setVariable(String, String)

run

public JDynamiTe run(java.io.InputStream inputStreamTemplateFile,
            java.lang.String defaultRootXMLInputDoc,
            java.util.Hashtable<java.lang.String,java.lang.String> keyValuesList,
            boolean verbose)

Reads, analyses and processes the input template file and then produces the output result. This method uses a JDynamiTe object to process the input template file and then produce the output result.
The global process of this method consists in:
1) processing all "simple" JDynamiTe Variables, by calling JDynamiTe.setVariable(String, String) method for each key-value pair.
2) processing recursively all XML Dynamic blocks, by calling the JDynamiTe.parseXMLDynElem() method.

Parameters:

inputStreamTemplateFile - InputStream attached to the input template. This value will be used to call the JDynamiTe.setInput(InputStream) method.

defaultRootXMLInputDoc - Default URI for first level XML dynamic block(s) which do not have an URI in their definition in template file. This optional parameter can be null.

keyValuesList - List of key-value pairs used to set values to the JDynamiTe variables contained in the input template. Each key-value pair will be passed to the JDynamiTe.setVariable(String, String) method.

verbose - If true, print on stderr output some information messages during document processing.

Returns:

If the inputStreamTemplateFile can be read and analysed, this method returns the JDynamiTe object used to process the template document.
Use then the JDynamiTe.toString() method on this returned object to get the parsing result (i.e. the populated output document).
If the inputTemplateFile is undefined or can not be read, this method returns null.

See Also:

JDynamiTe.setInput(String), JDynamiTe.setVariable(String, String)

run

public JDynamiTe run(java.lang.String defaultRootXMLInputDoc,
            java.util.Hashtable<java.lang.String,java.lang.String> keyValuesList,
            boolean verbose)

Processes the input template file and then produces the output result. It is assumed that the input template file has already been read and analysed by calling either run(String, String, Hashtable, boolean) method, or run(InputStream, String, Hashtable, boolean) method.
This method is the same than the run(String, String, Hashtable, boolean) method, except that there is no call to the JDynamiTe.setInput(String) or JDynamiTe.setInput(InputStream) method.
Call this method if the input template file does not change from one call to another, while you need to change other parameters such as Variable key-value list.

Parameters:

defaultRootXMLInputDoc - Default URI for first level XML dynamic block(s) which do not have an URI in their definition in template file. This optional parameter can be null.

keyValuesList - keyValuesList List of key-value pairs used to set values to the JDynamiTe variables contained in the input template. Each key-value pair will be passed to the JDynamiTe.setVariable(String, String) method.

verbose - If true, print on stderr output some information messages during document processing.

Returns:

This method returns null if no input template file was defined by a previous call to the run(String, String, Hashtable, boolean) method.
Otherwise this method returns the JDynamiTe object used to process the template document.
Use then the JDynamiTe.toString() method on this returned object to get the parsing result (i.e. the populated output document).
If the inputTemplateFile is undefined or can not be read, this method returns null.

main

public static void main(java.lang.String[] args)

Parameters:

args - Parameters for Command line invocation.

Usage:

JDynTool --template jdyn-template-file [--definition] [--keys] [--verbose] [--XMLdefaultRootDoc URI] [-D <key>=<value> ...]

--template jdyn-file
-t jdyn-file
Specify JDynamiTe input template file.

--definition
-d
Output on stderr the JDynamiTe input template file structure definition (as interpreted by JDynamiTe).

--keys
-k
Output on stderr the list of JDynamiTe Variable tags (keys) found in the JDynamiTe input template file.

--verbose
-v
Output on stderr some information messages during document processing.

--XMLdefaultRootDoc URI-path
-X URI-path
Default URI/path for first level XML dynamic blocks which do not have an URI-path in their definition in template file.

-D <key>=<value> ...
List of key-value pairs used to set values to the JDynamiTe variables contained in the input template}