Package de.hybris.ant.taskdefs.yunit
Class AggregateTransformer
java.lang.Object
de.hybris.ant.taskdefs.yunit.AggregateTransformer
Transform a JUnit xml report. The default transformation generates an html report in either framed or non-framed
style. The non-framed style is convenient to have a concise report via mail, the framed report is much more
convenient if you want to browse into different packages or testcases since it is a Javadoc like report.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classdefines acceptable formats. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static DocumentBuilderFactoryXML Parser factory accessible to subclassesprotected Documentthe xml document to processprotected Stringthe format to use for the report.static final Stringname of the frames format.static final Stringname of the no frames format.protected Filethe style directory.protected org.apache.tools.ant.TaskTaskprotected Filethe destination directory, this is the root from where html should be generated -
Constructor Summary
ConstructorsConstructorDescriptionAggregateTransformer(org.apache.tools.ant.Task task) constructor creating the transformer from the junitreport task. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcheck for invalid optionsorg.apache.tools.ant.taskdefs.XSLTProcess.ParamCreate an instance of an XSL parameter for configuration by Ant.protected static DocumentBuilderFactoryGet the Document Builder Factoryprotected org.apache.tools.ant.types.Resourceaccess the stylesheet to be used as a resource.protected StringGet the systemid of the appropriate stylesheet based on its name and styledir.voidsetExtension(String ext) set the extension of the output filesvoidsetFormat(AggregateTransformer.Format format) sets the format.voidsetStyledir(File styledir) set the style directory.voidset the destination directory.voidsetXmlDocument(Document doc) sets the input document.protected voidsetXmlfile(File xmlfile) Set the xml file to be processed.voidtransformation
-
Field Details
-
FRAMES
name of the frames format.- See Also:
-
NOFRAMES
name of the no frames format.- See Also:
-
task
protected org.apache.tools.ant.Task taskTask -
document
the xml document to process -
styleDir
the style directory. XSLs should be read from here if necessary -
toDir
the destination directory, this is the root from where html should be generated -
format
the format to use for the report. Must be FRAMES or NOFRAMES -
dbfactory
XML Parser factory accessible to subclasses
-
-
Constructor Details
-
AggregateTransformer
public AggregateTransformer(org.apache.tools.ant.Task task) constructor creating the transformer from the junitreport task.- Parameters:
task- task delegating to this class
-
-
Method Details
-
getDocumentBuilderFactory
Get the Document Builder Factory- Returns:
- the DocumentBuilderFactory instance in use
-
setFormat
sets the format.- Parameters:
format- Must be FRAMES or NOFRAMES
-
setXmlDocument
sets the input document.- Parameters:
doc- input dom tree
-
setXmlfile
Set the xml file to be processed. This is a helper if you want to set the file directly. Much more for testing purposes.- Parameters:
xmlfile- xml file to be processed- Throws:
org.apache.tools.ant.BuildException- if the document cannot be parsed.
-
setStyledir
set the style directory. It is optional and will override the default xsl used.- Parameters:
styledir- the directory containing the xsl files if the user would like to override with its own style.
-
setTodir
set the destination directory.- Parameters:
todir- the destination directory
-
setExtension
set the extension of the output files- Parameters:
ext- extension.
-
createParam
public org.apache.tools.ant.taskdefs.XSLTProcess.Param createParam()Create an instance of an XSL parameter for configuration by Ant.- Returns:
- an instance of the Param class to be configured.
- Since:
- Ant 1.7
-
transform
public void transform() throws org.apache.tools.ant.BuildExceptiontransformation- Throws:
org.apache.tools.ant.BuildException- exception if something goes wrong with the transformation.
-
getStylesheet
protected org.apache.tools.ant.types.Resource getStylesheet()access the stylesheet to be used as a resource.- Returns:
- stylesheet as a resource
-
checkOptions
protected void checkOptions() throws org.apache.tools.ant.BuildExceptioncheck for invalid options- Throws:
org.apache.tools.ant.BuildException- if something goes wrong.
-
getStylesheetSystemId
Get the systemid of the appropriate stylesheet based on its name and styledir. If no styledir is defined it will load it as a java resource in the xsl child package, otherwise it will get it from the given directory.- Returns:
- system ID of the stylesheet.
- Throws:
IOException- thrown if the requested stylesheet does not exist.
-