de.xoev.xdomea.viewer.modules
Class TransformationModule

java.lang.Object
  extended by de.xoev.xdomea.viewer.modules.AbstractModule
      extended by de.xoev.xdomea.viewer.modules.TransformationModule
All Implemented Interfaces:
Module

public class TransformationModule
extends AbstractModule

Diese Klasse stellt Funktionalitäten zum Transformieren einer XML-Dateien bereit

TransformationModule tm = new TransformationModule();
tm.setInput(new File("file2transform.xml"));
tm.setVersion("V2.1.0");
tm.setOutputFile(new File("index.html"));
File output = tm.process();

Author:
Sächsisches Staatsministerium der Justiz und für Europa

Field Summary
 
Fields inherited from class de.xoev.xdomea.viewer.modules.AbstractModule
log
 
Constructor Summary
TransformationModule()
          erzeugt eine TransformationModule-Instanz
 
Method Summary
 File getOutputFile()
           
 Hashtable<String,String> getParams()
           
 String getVersion()
           
 File process()
          verarbeitet den angegebenen Input. Die Methode Module.setInput(File) muss zuvor aufgerufen worden sein, um den Input zu verarbeiten. Weiterhin müssen die Methoden setOutputFile(File) und setVersion(String) aufgerufen worden sein, um eine Transformation durchführen zu können.
 void setOutputFile(File outputFile)
           
 void setParams(Hashtable<String,String> params)
          Bei der Transformierung können globale Parameter verwendet werden.
 void setVersion(String version)
          die verwendete Konfiguration ist abhängig von der xdomea-Version.
 
Methods inherited from class de.xoev.xdomea.viewer.modules.AbstractModule
getInput, setInput
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TransformationModule

public TransformationModule()
erzeugt eine TransformationModule-Instanz

Method Detail

setOutputFile

public void setOutputFile(File outputFile)
Parameters:
outputFile - die Ausgabe-Datei

getOutputFile

public File getOutputFile()
Returns:
die Ausgabe-Datei

setVersion

public void setVersion(String version)
die verwendete Konfiguration ist abhängig von der xdomea-Version. Daher muss sie mit dieser Methode gesetzt werden

Parameters:
version - die zu verwendende xdomea-Version

getVersion

public String getVersion()
Returns:
die zu verwendende xdomea-Version

getParams

public Hashtable<String,String> getParams()
Returns:
die Parameter, die bei der Transformierung berücksichtigt werden

setParams

public void setParams(Hashtable<String,String> params)
Bei der Transformierung können globale Parameter verwendet werden. Diese Parameter werden zur Laufzeit im Transformationsergebnis ersetzt. Die zu verwendenden Parameter können mit dieser Methode gesetzt werden.

Parameters:
params - die Parameterwerte, die bei der Transformierung berücksichtigt werden sollen

process

public File process()
             throws XDomeaViewerException
verarbeitet den angegebenen Input. Die Methode Module.setInput(File) muss zuvor aufgerufen worden sein, um den Input zu verarbeiten. Weiterhin müssen die Methoden setOutputFile(File) und setVersion(String) aufgerufen worden sein, um eine Transformation durchführen zu können. Sollten in dem XSL-Template globale Parameter vorkommen, dann können diese Parameter mit der Methode setParams(Hashtable) gesetzt werden. Das zu benutzende XSL-Template wird mit Hilfe des ConfigurationService ermittelt.

Specified by:
process in interface Module
Specified by:
process in class AbstractModule
Returns:
der Output der Verarbeitung
Throws:
XDomeaViewerException - XDomeaViewerException wenn bei der Verarbeitung des Inputs ein Fehler aufgetreten ist


Copyright © 2009. All Rights Reserved.