Package com.altova.raptorxml
Interface XSLT
public interface XSLT
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionvoid
addExternalParameter
(String name, String value) Add name and value for an external parameter.void
Clear the list of external parameters.boolean
Execute and save the result to file.Execute and return the result as string.Execute and return the result as string.Returns the additional outputs of the last executed jobGet the last error message from the engine.Returns the main output of the last executed jobboolean
isValid()
Validates the XSLT filevoid
Configure the usage of the xsi:schemaLocation hintsvoid
setChartExtensionsEnabled
(boolean enable) Enable or disable the chart extensions.void
setDotNetExtensionsEnabled
(boolean enable) Enable or disable the .NET extensions.void
setIndentCharacters
(String chars) Characters used for indentation.void
setInitialTemplateMode
(String mode) Set the initial template mode for the transformation.void
setInputXMLFileName
(String xmlFile) Set the file name for the XML data used as input.void
setInputXMLFromText
(String xmlText) Set the text value for the input XML data.void
Location of the Java Barcode extensionvoid
setJavaExtensionsEnabled
(boolean enable) Enable or disable the Java extensions.void
setLoadXMLWithPSVI
(boolean load) Enable/disable loading XML with PSVIvoid
setNamedTemplateEntryPoint
(String template) Set the initial template name for the transformation.void
Configure the usage of the xsi:schemaLocation hintsvoid
Configure the usage of the xsi:schemaLocation hintsvoid
setStreamingSerialization
(boolean support) Enable/disable streaming serializationvoid
setVersion
(XSLT.ENUMXSLTVersion version) Set the XSLT versionvoid
setXincludeSupport
(boolean support) Enable/disable xinclude supportvoid
setXMLValidationErrorAsWarning
(boolean treat) Enable/disable treating XML validation errors as warningsvoid
Processing modevoid
setXSDVersion
(XMLValidator.ENUMXSDVersion version) XSD specification versionvoid
setXSLFileName
(String xslFile) Set the file for the XSLT data.void
setXSLFromText
(String xslText) Set the text value
-
Method Details
-
isValid
Validates the XSLT file- Throws:
RaptorXMLException
-
execute
Execute and save the result to file. In case of an error, use functiongetLastErrorMessage()
to get additional information.- Parameters:
outputFile
- path to result file- Returns:
- true on success, false on failure
- Throws:
RaptorXMLException
-
executeAndGetResultAsString
Execute and return the result as string. In case of an error, use functiongetLastErrorMessage()
to get additional information.- Returns:
- result as string.
- Throws:
RaptorXMLException
-
executeAndGetResultAsStringWithBaseOutputURI
Execute and return the result as string. In case of an error, use functiongetLastErrorMessage()
to get additional information.- Returns:
- result as string.
- Throws:
RaptorXMLException
-
setVersion
Set the XSLT version- Parameters:
version
- The version: 1.0, 2.0 or 3.0
-
setInputXMLFileName
Set the file name for the XML data used as input.- Parameters:
xmlFile
- path to XML file.
-
setXSLFileName
Set the file for the XSLT data.- Parameters:
xslFile
- path to XSL file
-
setInputXMLFromText
Set the text value for the input XML data.- Parameters:
xmlText
- XML text
-
setXSLFromText
Set the text value- Parameters:
xslText
- XML text
-
addExternalParameter
Add name and value for an external parameter.- Parameters:
name
- a valid QName as the parameter namevalue
- value for the parameter - value which will be evaluated as an xpath expression
-
clearExternalParameterList
void clearExternalParameterList()Clear the list of external parameters. -
setNamedTemplateEntryPoint
Set the initial template name for the transformation. -
setInitialTemplateMode
Set the initial template mode for the transformation. -
setDotNetExtensionsEnabled
void setDotNetExtensionsEnabled(boolean enable) Enable or disable the .NET extensions.- Parameters:
enable
- 'true' to enable, 'false' otherwise
-
setJavaExtensionsEnabled
void setJavaExtensionsEnabled(boolean enable) Enable or disable the Java extensions.- Parameters:
enable
- 'true' to enable, 'false' otherwise
-
setJavaBarcodeExtensionLocation
Location of the Java Barcode extension -
setChartExtensionsEnabled
void setChartExtensionsEnabled(boolean enable) Enable or disable the chart extensions.- Parameters:
enable
- 'true' to enable, 'false' otherwise
-
getLastErrorMessage
String getLastErrorMessage()Get the last error message from the engine.- Returns:
- last error message
-
setXSDVersion
XSD specification version- Parameters:
version
- Version to be used by the validation engine
-
setXincludeSupport
void setXincludeSupport(boolean support) Enable/disable xinclude support -
setSchemalocationHints
Configure the usage of the xsi:schemaLocation hints -
seSchemaImports
Configure the usage of the xsi:schemaLocation hints -
setSchemaMapping
Configure the usage of the xsi:schemaLocation hints -
setXMLValidationMode
Processing mode- Parameters:
mode
- XML Validation mode to be used by the validation engine
-
setIndentCharacters
Characters used for indentation. -
setStreamingSerialization
void setStreamingSerialization(boolean support) Enable/disable streaming serialization -
setLoadXMLWithPSVI
void setLoadXMLWithPSVI(boolean load) Enable/disable loading XML with PSVI -
setXMLValidationErrorAsWarning
void setXMLValidationErrorAsWarning(boolean treat) Enable/disable treating XML validation errors as warnings -
getMainOutput
String getMainOutput()Returns the main output of the last executed job -
getAdditionalOutputs
String getAdditionalOutputs()Returns the additional outputs of the last executed job
-