Java

www.altova.com Alle erweitern/reduzieren Dieses Kapitel drucken Vorherige Seite Eine Ebene nach oben Nächste Seite

Startseite >  Altova StyleVision Server 2019 > StyleVision Server API > API-Referenz >

Java

Das Paket com.altova.stylevisionserver besteht aus den folgenden Klassen:

 

public class StyleVisionServer (siehe Beschreibung unten)
public class StyleVisionServerException extends Exception

 

Die Klasse StyleVisionServer

Die Klasse StyleVisionServer erstellt eine neue StyleVision Server Objektinstanz und bietet Zugriff auf StyleVision Server. Im Folgenden finden Sie eine Beschreibung der Methoden der Schnittstelle StyleVisionServer.

 

 

Methoden der Klasse StyleVisionServer

Im Folgenden finden Sie eine alphabetisch geordnete Liste der Methoden der Klasse StyleVisionServer.

 

Click to expand/collapseaddParameter

public void addParameter(String name, String value)

Fügt den Namen und Wert eines neuen Parameters hinzu. Jeder Parameter und sein Wert werden in einem separaten Methodenaufruf definiert. Parameter müssen im XSLT-Dokument deklariert sein.

Parameter:

name: Enthält den Namen des Parameters als String.

value: Enthält den Wert des Parameters als String.

 

Click to expand/collapseclearParameterList

public void clearParameterList()

Löscht die Liste der Parameter.

 

Click to expand/collapsegenerate

public boolean generate(String transfPath)

Verarbeitet die in transfPath definierte PXF-Datei. Löst StyleVisionServerException aus.

Parameter:

transfPath: eine absolute URL, die den Pfad der PXF-Datei angibt.

Rückgabe:

true() bei erfolgreicher Ausführung

false() wenn die Ausführung fehlschlägt

Verwenden Sie bei einem Fehler getLastExecutionMessage()

 

Click to expand/collapsegetAPIMajorVersion

public int getAPIMajorVersion()

Ruft die Hauptversion der StyleVision Server API ab. Sie unterscheidet sich eventuell von der Produktversion, wenn die API mit einem anderen Server verbunden ist.

 

Click to expand/collapsegetAPIMinorVersion

public int getAPIMinorVersion()

Ruft die Nebenversion der StyleVision Server API ab. Sie unterscheidet sich eventuell von der Produktversion, wenn die API mit einem anderen Server verbunden ist.

 

Click to expand/collapsegetAPIServicePackVersion

public int getAPIServicePackVersion()

Ruft die Service Pack-Version der StyleVision Server API ab. Sie unterscheidet sich eventuell von der Produktversion, wenn die API mit einem anderen Server verbunden ist.

 

Click to expand/collapsegetLastExecutionMessage

public String getLastExecutionMessage()

Ruft die beim letzten generate-Befehl erhaltene Meldung auf.

 

Click to expand/collapsegetMajorVersion

public int getMajorVersion()

Ruft die Hauptversion der Applikation ab.

 

Click to expand/collapsegetMinorVersion

public int getMinorVersion()

Ruft die Nebenversion der Applikation ab.

 

Click to expand/collapsegetProductName

public String getProductName()

Ruft den Produktnamen ab.

 

Click to expand/collapsegetProductNameAndVersion

public String getProductNameAndVersion()

Ruft den vollständigen Namen und die Versionsnummer des Produkts ab.

 

Click to expand/collapsegetServicePackVersion

public int getServicePackVersion()

Ruft die Service Pack-Version von StyleVision Server ab.

 

Click to expand/collapseis64bit

public boolean is64bit()

Überprüft, ob die ausführbare Datei eine 64-Bit-Datei ist.

Rückgabe:

true() für StyleVision Server (x64), andernfalls false().

 

Click to expand/collapsesetInputXML

public void setInputXML(String path)

Definiert die zu verarbeitende XML-Datei. Dabei muss es sich um den Pfad der in der PXF-Datei definierten XML-Arbeitsdatei handeln.

Parameter:

path: Enthält den Pfad der XML-Arbeitsdatei in der PXF-Datei.

 

Click to expand/collapsesetOutputDOCX

public void setOutputDOCX(String path)

Definiert den Namen und Pfad der zu generierenden DOCX-Datei.

Parameter:

path: Der Name und Pfad der zu generierenden DOCX-Datei.

 

Click to expand/collapsesetOutputFO

public void setOutputFO(String path)

Definiert den Namen und Pfad der zu generierenden FO-Datei.

Parameter:

path: Der Name und Pfad der zu generierenden FO-Datei

 

Click to expand/collapsesetOutputHTML

public void setOutputHTML(String path)

Definiert den Namen und Pfad der zu generierenden HTML-Datei.

Parameter:

path: Der Name und Pfad der zu generierenden HTML-Datei.

 

Click to expand/collapsesetOutputPDF

public void setOutputPDF(String path)

Definiert den Namen und Pfad der zu generierenden PDF-Datei.

Parameter:

path: Der Name und Pfad der zu generierenden PDF-Datei.

 

Click to expand/collapsesetOutputRTF

public void setOutputRTF(String path)

Definiert den Namen und Pfad der zu generierenden RTF-Datei.

Parameter:

path: Der Name und Pfad der zu generierenden RTF-Datei.

 

Click to expand/collapsesetServerPath

public void ssetServerPath(String serverFile)

Definiert den Pfad der ausführbaren StyleVisionServer Datei.

Parameter:

serverFile: Der Pfad der ausführbaren StyleVisionServer Datei.

 

Click to expand/collapsesetWhereClause

public void setWhereClause(String whereClause)

Definiert eine SQL WHERE-Klausel, mit der festgelegt wird, welche Zeilen einer DB-XML-Schemaquelle verarbeitet werden sollen.

Parameter:

whereClause: Die SQL Where-Klausel, die angibt, welche Zeilen einer DB-XML-Schemaquelle verarbeitet werden sollen.

 

Click to expand/collapsesetWorkingDirectory

public void setWorkingDirectory(String workingDirectory)

Definiert ein Standardverzeichnis. Relative Pfade werden relativ zum Verzeichnis aufgelöst.

Parameter:

workingDirectory: Der Pfad des Standard (Arbeits)-Verzeichnisses

 

 


© 2019 Altova GmbH