Java

www.altova.com Expand/Collapse All Print this Topic Previous Page Up One Level

Home >  StyleVision Server API > API Reference >

Java

The package com.altova.stylevisionserver consists of the following classes:

 

public class StyleVisionServer (described below)
public class StyleVisionServerException extends Exception

 

StyleVisionServer class

The StyleVisionServer class creates a new StyleVision Server object instance, and provides access to StyleVision Server. The methods of the StyleVisionServer interface are described below.

 

 

Methods of StyleVisionServer class

The methods of the StyleVisionServer class are listed alphabetically below.

 

Click to expand/collapseaddParameter

public void addParameter(String name, String value)

Adds the name and value of a new parameter. Each parameter and its value is specified in a separate call to the method. Parameters must be declared in the XSLT document.

Parameters:

name: Holds the name of the parameter as a string.

value: Holds the value of the parameter as a string.

 

Click to expand/collapseclearParameterList

public void clearParameterList()

Clears the list of parameters.

 

Click to expand/collapsegenerate

public boolean generate(String transfPath)

Processes the PXF file specified in transfPath. Throws StyleVisionServerException.

Parameters:

transfPath: An absolute URL giving the location of the PXF file.

Returns:

true() if execution is successful

false() if execution fails

In case of an error, use getLastExecutionMessage()

 

Click to expand/collapsegetAPIMajorVersion

public int getAPIMajorVersion()

Gets the major version of the StyleVision Server API. It can be different from the product version if the API is connected to another server.

 

Click to expand/collapsegetAPIMinorVersion

public int getAPIMinorVersion()

Gets the minor version of the StyleVision Server API. It can be different from the product version if the API is connected to another server.

 

Click to expand/collapsegetAPIServicePackVersion

public int getAPIServicePackVersion()

Gets the service pack version of the StyleVision Server API. It can be different from the product version if the API is connected to another server.

 

Click to expand/collapsegetLastExecutionMessage

public String getLastExecutionMessage()

Gets the message received during the last generate command.

 

Click to expand/collapsegetMajorVersion

public int getMajorVersion()

Gets the major version of the application.

 

Click to expand/collapsegetMinorVersion

public int getMinorVersion()

Gets the minor version of the application.

 

Click to expand/collapsegetProductName

public String getProductName()

Gets the product name.

 

Click to expand/collapsegetProductNameAndVersion

public String getProductNameAndVersion()

Gets the complete name and version number of the product.

 

Click to expand/collapsegetServicePackVersion

public int getServicePackVersion()

Gets the service pack version of the StyleVision Server.

 

Click to expand/collapseis64bit

public boolean is64bit()

Checks whether the executable is 64-bit.

Returns:

true() for StyleVision Server (x64), false() otherwise.

 

Click to expand/collapsesetInputXML

public void setInputXML(String path)

Sets the XML file to process. This must be the path of the Working XML File that is specified in the PXF file.

Parameters:

path: Holds the path of the Working XML file in the PXF file.

 

Click to expand/collapsesetOutputDOCX

public void setOutputDOCX(String path)

Sets the path and name of the DOCX file to generate.

Parameters:

path: The path and name of the DOCX file to generate.

 

Click to expand/collapsesetOutputFO

public void setOutputFO(String path)

Sets the path and name of the FO file to generate.

Parameters:

path: The path and name of the FO file to generate.

 

Click to expand/collapsesetOutputHTML

public void setOutputHTML(String path)

Sets the path and name of the HTML file to generate.

Parameters:

path: The path and name of the HTML file to generate.

 

Click to expand/collapsesetOutputPDF

public void setOutputPDF(String path)

Sets the path and name of the PDF file to generate.

Parameters:

path: The path and name of the PDF file to generate.

 

Click to expand/collapsesetOutputRTF

public void setOutputRTF(String path)

Sets the path and name of the RTF file to generate.

Parameters:

path: The path and name of the RTF file to generate.

 

Click to expand/collapsesetServerPath

public void setServerPath(String serverFile)

Sets the path of the StyleVisionServer executable.

Parameters:

serverFile: The path of the StyleVisionServer executable.

 

Click to expand/collapsesetWhereClause

public void setWhereClause(String whereClause)

Sets an SQL WHERE clause that determines the rows of a DB-XML schema source to process.

Parameters:

whereClause: The SQL WHERE clause that determines the rows of a DB-XML schema source to process.

 

Click to expand/collapsesetWorkingDirectory

public void setWorkingDirectory(String workingDirectory)

Sets a default directory. Relative paths are resolved relative to this directory.

Parameters:

workingDirectory: The path of the default (working) directory.

 

 


© 2019 Altova GmbH