org.jenkinsci.lib.dtkit.model

Class InputMetricXSL

java.lang.Object

org.jenkinsci.lib.dtkit.model.InputMetric

org.jenkinsci.lib.dtkit.model.InputMetricXSL

All Implemented Interfaces:

Serializable

public abstract class InputMetricXSL
extends InputMetric

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InputMetricXSL()

Method Summary

Modifier and Type	Method and Description
void	convert(File inputFile, File outFile) Convert an input file to an output file Give your conversion process Input and Output files are relatives to the filesystem where the process is executed on (like Hudson agent).
void	convert(File inputFile, File outFile, File externalXsl, Map<String,Object> params) Convert an input file to an output file Give your conversion process Input and Output files are relatives to the filesystem where the process is executed on (like Hudson agent)
void	convert(File inputFile, File outFile, Map<String,Object> params) Convert an input file to an output file Give your conversion process Input and Output files are relatives to the filesystem where the process is executed on (like Hudson agent).
void	convert(File inputFile, File outFile, String externalXslContent, Map<String,Object> params) Convert an input file to an output file Give your conversion process Input and Output files are relatives to the filesystem where the process is executed on (like Hudson agent)
boolean	equals(Object o)
InputMetricType	getInputMetricType() All the subclasses will be of XSL
Class<?>	getInputXsdClass() Gets the Class (namespace) of the xsd file resource
File[]	getInputXsdFileList()
String[]	getInputXsdNameList() the XSD file associated to this tool result file
InputStream[]	getListXsdInputStream()
String[]	getOutputXsdNameList() the XSD file associated to this output format
String	getUserContentXSLDirRelativePath()
File	getXslFile() Overrides this method if you want to provide your own xsl (independent of its location) Used for custom type where the user specifies its own xsl
InputStream	getXslInputStream()
String	getXslName() the XSL file associated to this tool
Class<?>	getXslResourceClass() Gets the Class (namespace) of the xsl file resource
int	hashCode()
boolean	validateInputFile(File inputXMLFile) Gives the validation process for the input file.
boolean	validateOutputFile(File inputXMLFile) Gives the validation process for the output file.

Methods inherited from class org.jenkinsci.lib.dtkit.model.InputMetric

getInputValidationErrors, getLabel, getOutputFormatType, getOutputValidationErrors, getToolName, getToolType, getToolVersion, isDefault, setInputMetricType, setInputValidationErrors, setLabel, setOutputFormatType, setOutputValidationErrors, setToolName, setToolType, setToolVersion

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputMetricXSL

public InputMetricXSL()

Method Detail

getXslResourceClass

public Class<?> getXslResourceClass()

Gets the Class (namespace) of the xsl file resource

Returns:

the resource class (for loading)

getInputXsdClass

public Class<?> getInputXsdClass()

Gets the Class (namespace) of the xsd file resource

Returns:

the xsd class (for loading)

getXslName

public String getXslName()

the XSL file associated to this tool

Returns:

the relative xsl path

getXslFile

public File getXslFile()

Overrides this method if you want to provide your own xsl (independent of its location) Used for custom type where the user specifies its own xsl

Returns:

null by default

getXslInputStream

public InputStream getXslInputStream()
                              throws IOException

Throws:

IOException

getInputXsdNameList

public String[] getInputXsdNameList()

the XSD file associated to this tool result file

Returns:

the xsd name. Can be null if there no XSD for the input file of the current tool type

getInputXsdFileList

public File[] getInputXsdFileList()

getListXsdInputStream

public InputStream[] getListXsdInputStream()
                                    throws IOException

Throws:

IOException

getOutputXsdNameList

public String[] getOutputXsdNameList()

the XSD file associated to this output format

Returns:

the relative xsd path. Can be null if there no XSD for the output format

getInputMetricType

public InputMetricType getInputMetricType()

All the subclasses will be of XSL

Overrides:

getInputMetricType in class InputMetric

Returns:

XSL type

getUserContentXSLDirRelativePath

public String getUserContentXSLDirRelativePath()

convert

public void convert(File inputFile,
                    File outFile,
                    Map<String,Object> params)
             throws ConversionException

Description copied from class: InputMetric

Convert an input file to an output file Give your conversion process Input and Output files are relatives to the filesystem where the process is executed on (like Hudson agent).

Specified by:

convert in class InputMetric

Parameters:

inputFile - the input file to convert

outFile - the output file to convert

params - the conversion parameters

Throws:

ConversionException - an application Exception to throw when there is an error of conversion The exception is catched by the API client (as Hudson plugin)

convert

public void convert(File inputFile,
                    File outFile)
             throws ConversionException

Description copied from class: InputMetric

Convert an input file to an output file Give your conversion process Input and Output files are relatives to the filesystem where the process is executed on (like Hudson agent).

Overrides:

convert in class InputMetric

Parameters:

inputFile - the input file to convert

outFile - the output file to convert

Throws:

ConversionException - an application Exception to throw when there is an error of conversion The exception is catched by the API client (as Hudson plugin)

convert

public void convert(File inputFile,
                    File outFile,
                    File externalXsl,
                    Map<String,Object> params)
             throws ConversionException

Convert an input file to an output file Give your conversion process Input and Output files are relatives to the filesystem where the process is executed on (like Hudson agent)

Parameters:

inputFile - the input file to convert

outFile - the output file to convert

externalXsl - an external xsl file such as a user xsl

params - the conversion parameters

Throws:

ConversionException - an application Exception to throw when there is an error of conversion The exception is catched by the API client (as Hudson plugin)

convert

public void convert(File inputFile,
                    File outFile,
                    String externalXslContent,
                    Map<String,Object> params)
             throws ConversionException

Convert an input file to an output file Give your conversion process Input and Output files are relatives to the filesystem where the process is executed on (like Hudson agent)

Parameters:

inputFile - the input file to convert

outFile - the output file to convert

externalXslContent - an external xsl content such as a user xsl

params - the conversion parameters

Throws:

ConversionException - an application Exception to throw when there is an error of conversion The exception is catched by the API client (as Hudson plugin)

validateInputFile

public boolean validateInputFile(File inputXMLFile)
                          throws ValidationException

Description copied from class: InputMetric

Gives the validation process for the input file.

Specified by:

validateInputFile in class InputMetric

Parameters:

inputXMLFile - to validate

Returns:

true if the input file is valid, false otherwise

Throws:

ValidationException

validateOutputFile

public boolean validateOutputFile(File inputXMLFile)
                           throws ValidationException

Description copied from class: InputMetric

Gives the validation process for the output file.

Specified by:

validateOutputFile in class InputMetric

Parameters:

inputXMLFile - to validate

Returns:

true if the input file is valid, false otherwise

Throws:

ValidationException

equals

public boolean equals(Object o)

Overrides:

equals in class InputMetric

hashCode

public int hashCode()

Overrides:

hashCode in class InputMetric