Xslt

java.lang.Object
- org.vishia.xml.Xslt

```
public class Xslt
extends java.lang.Object
```
vishia XSLT Translator.

This translator calls the java-standard XSLT-engine defined with javax.xml.transform.TransformerFactory. The cmdLine-option -xslt:TRANSFORMER determines, which Transformer is used. The default-value is net.sf.saxon.TransformerFactoryImpl, therefore this Transformer is recommended to use. It should be provided by the adequate jar-File specified in the java's-CLASSPATH.

The vishia-XSLT prepares some inputs before calling the outside given Transformer:

Multiple inputs:
More as one XML-Inputfile is able to use as input. All input file-contents are disposed after a internal created < root> root-Element. It means, the translation file have to be regard this additional < root> root-Element. Write:
```
     < xsl:apply-templates match="/root" >
        ....
     
   
```
instead the often used
```
     < xsl:apply-templates match="/" >
        ....
     
   
```
Replacing of spaces of input:
The XML file representation may contain any white spaces (more as one space, line feed, indentation) between the XML-elements. It is a method of beautification of the appearance of the file content. The white spaces may be included by any XML-writer independent of the meaning of the content. But if the input should present a text with formatted inner elements (maybe XHTML), the white spaces may be interpreted as really text characters. The class XmlExtensions contains a static method org.vishia.xml.XmlExtensions.readXmlFileTrimWhiteSpace(File) which is used here if an input is designated with the cmdLine option -j:FILE.

Expansion of wikistyle:
This feature is not implemented yet. The conversion of WikistyleTextToSimpleXml is implemented instead in the ZBNF2Xml-conversion (class ZbnfXmlOutput and in the class CorrectHref for documentation generation. It was contained here in the past. It isn't supported yet, because the conversion routine is changed using the XmlNode, which is not directly compatible with JDOM. An adaption is existing in the XmlNodeJdom, but it isn't used here yet.

Beautification of output:
This feature was implemented here in the past before using the SAXON-XSLT. But the SAXON writes the file in an adequate style itself.

A beautification should generate indentation automatically. But it should regard textual contents: If any element contains a textual content, its whole content should be written in one line to prevent additional white spaces which may be confused the textual content. Such an XML-writer is implemented in org.vishia.xml.XmlExtensions.writeXmlBeautificatedTextFile(Element, File, Charset)}. This writer uses JDOM as input. This is the older implementation. A newer implementation of this feature is present in SimpleXmlOutputter.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class Xslt.Parameter

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Xslt.Parameter`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`bWikiFormat` Set on command line option.
`protected java.util.List<Xslt.Parameter>`	`params`
`protected java.lang.String`	`sFileOut` Cmdline-argument, set on -y option.
`protected java.lang.String`	`sFileXslp` CmdLine-argument set on -p option: XSLT-File pre-converted with `Xsltpre`.
`protected java.lang.String`	`sFileXslt` CmdLine-argument set on -t option: XSLT-File for Transformer.
`protected java.lang.String`	`sTransformer` Class which is used by the javax.xml.transform.TransformerFactory It is set with System.setProperty("javax.xml.transform.TransformerFactory", ...);
`static java.lang.String`	`sVersion` Version, history and license.
`protected XmlMReader`	`xmlMReader` Instance to process input files.

Constructor Summary

Constructors
Constructor and Description
`Xslt(java.lang.ClassLoader javacpArg, java.lang.String sXmlReader, java.lang.String sXmlTranslator)` Instantiation for Using in a Java/JZcmd-context.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addInputfile(java.lang.String sFile)` Adds an input file with standard handling.
`void`	`addInputfileExpandWikiformat(java.lang.String sFile)` Adds an input file wich's content is expand as Wikiformat if the tag TODO.
`void`	`addInputfileReplaceWith1Space(java.lang.String sFile)` Adds an input file wich's white spaces are replaced by 1 space.
`static java.lang.String`	`exec(java.lang.String[] sArgs)` Invocation from another java program without exit the JVM
`static void`	`main(java.lang.String[] sArgs)` main started from java.
`void`	`setOutputfile(java.lang.String sFile)`
`void`	`setXslpfile(java.lang.String sFile)`
`void`	`setXsltfile(java.lang.String sFile)`
`void`	`transform()` Reads the input files and executes the transformation.

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

- Field Detail
  - bWikiFormat
```
protected boolean bWikiFormat
```
    Set on command line option. If true, after xslt translation the output tree is evaluate for elements with attribute expandWikistyle or WikiFormat. This elements are expanded.
  - params
```
protected java.util.List<Xslt.Parameter> params
```
  - sFileOut
```
protected java.lang.String sFileOut
```
    Cmdline-argument, set on -y option. Outputfile to output something.
  - sFileXslp
```
protected java.lang.String sFileXslp
```
    CmdLine-argument set on -p option: XSLT-File pre-converted with Xsltpre. If it is null, the is used as input. . NOTE: If the XSLT-File given in sFileXslt- element is newer as this given file, the first one will not overwritten by this given file. This feature may be able to use for fine adjustments of content while debugging a script.
  - sFileXslt
```
protected java.lang.String sFileXslt
```
    CmdLine-argument set on -t option: XSLT-File for Transformer. Either it is the primary file, or, if sFileXslp is given, it is the name of the output file.
  - sTransformer
```
protected java.lang.String sTransformer
```
    Class which is used by the javax.xml.transform.TransformerFactory It is set with System.setProperty("javax.xml.transform.TransformerFactory", ...);
  - sVersion
```
public static final java.lang.String sVersion
```
    Version, history and license.
    - 2014-06-01 Hartmut new Xslt(ClassLoader, String, String) and transform() to invoke from Java context with a different ClassLoader, used in JZcmd
    - 2013-06-30 Hartmut new: exec() for calling from inside Java
    - 2009-12-29 Hartmut new: The transformer class is now able to define via param -xslt:, so the SAXON isn't compiled fix.
    - 2009-12-29 Hartmut new: A Xslp-file is translated to the xsl-format, param -p:, the xsl is stored if param -t: is given.^
    - 2009-12-29 Hartmut new: params for translation may be defined, using name=value as param of invocation.
    - 2009-12-29 Hartmut new: The output format isn't fixed to XML, at may be text too. Depending on entry in XSL-File.
    - 2009-31-03 Hartmut: Cmd line argument separator : possible, outputs for help improved.
    - 2006-05-00 Hartmut: creation
    Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:
    1. You can use this source without any restriction for any desired purpose.
    2. You can redistribute copies of this source to everybody.
    3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
    4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
    5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.
    If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.
    See Also:
    Constant Field Values
  - xmlMReader
```
protected XmlMReader xmlMReader
```
    Instance to process input files. This instance holds informations about input files with several reading conditions and contains a xml parser call.
- Constructor Detail
  - Xslt
```
public Xslt(java.lang.ClassLoader javacpArg,
    java.lang.String sXmlReader,
    java.lang.String sXmlTranslator)
     throws java.lang.ClassNotFoundException,
            java.lang.InstantiationException,
            java.lang.IllegalAccessException
```
    Instantiation for Using in a Java/JZcmd-context. It allows to use a special reader for multi xml files and any XSL translator. The translator is a standard Java XSLT transformer wich's interfaces are defined in ,,javax.xml.transform,,.
    
    Parameters:
    javacp - The Loader where the reader and translator should be found, null if they are in the same Java classpath as this.
    sXmlReader - "package.path.Class" of instanceof XmlMReader. That is a multi XML reader.
    sXmlTranslator - "package.path.Class" of instanceof TransformerFactory.
    
    Throws:
    
    java.lang.ClassNotFoundException
    
    java.lang.IllegalAccessException
    
    java.lang.InstantiationException
- Method Detail
  - addInputfile
```
public void addInputfile(java.lang.String sFile)
```
    Adds an input file with standard handling.
    
    Parameters:
    sFile -
  - addInputfileExpandWikiformat
```
public void addInputfileExpandWikiformat(java.lang.String sFile)
```
    Adds an input file wich's content is expand as Wikiformat if the tag TODO.
    
    Parameters:
    sFile -
  - addInputfileReplaceWith1Space
```
public void addInputfileReplaceWith1Space(java.lang.String sFile)
```
    Adds an input file wich's white spaces are replaced by 1 space.
    
    Parameters:
    sFile -
  - exec
```
public static java.lang.String exec(java.lang.String[] sArgs)
```
    Invocation from another java program without exit the JVM
    
    Parameters:
    sArgs - same like main(String[])
    
    Returns:
    "" or an error String
  - main
```
public static void main(java.lang.String[] sArgs)
```
    main started from java.
    
    Command line options:
```
      "invoke { -[i|j|k]:INPUT } [-t:XSLT] [-p:XSLP] -y:OUTPUT [-xslt:TRANSFORMER]");
      "-i:INPUT-XML-file");
      "-j:INPUT-XML-file, Whitespaces will replaced with 1 space");
      "-t:XSLT: xsl-script XML2-compatible, it is output if -p:XSLP is given");
      "-p:XSLP: Script pretranslated with Xsltpre, than -t:XSLT will be created if older.");
      "         If no option -t:XSLT is given, XSLT will be created parallel with .xsl as extension.");
      "-y:OUTPUT-file");
      "-xslt:TRANSFORMER Set the class for Transformer-Implementation. Default is " + sTransformer);
      
```
  - setOutputfile
```
public void setOutputfile(java.lang.String sFile)
```
  - setXslpfile
```
public void setXslpfile(java.lang.String sFile)
```
  - setXsltfile
```
public void setXsltfile(java.lang.String sFile)
```
  - transform
```
public void transform()
               throws javax.xml.parsers.ParserConfigurationException,
                      java.io.FileNotFoundException,
                      java.io.IOException,
                      javax.xml.transform.TransformerException,
                      XmlException
```
    Reads the input files and executes the transformation. If it is called outside of the main,
    - the input files should be set with addInputfile(String),
    - the transformation file should be set either with setXsltfile(String) or setXslpfile(String)
    - and the output file should be set with #setOutfile(String).
    Throws:
    
    javax.xml.parsers.ParserConfigurationException
    
    java.io.IOException
    
    SAXException
    
    java.io.FileNotFoundException
    
    javax.xml.transform.TransformerException
    
    XmlException

Class Xslt

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bWikiFormat

params

sFileOut

sFileXslp

sFileXslt

sTransformer

sVersion

xmlMReader

Constructor Detail

Xslt

Method Detail

addInputfile

addInputfileExpandWikiformat

addInputfileReplaceWith1Space

exec

main

setOutputfile

setXslpfile

setXsltfile

transform