org.xwiki.tool.xar

Class Transformation

java.lang.Object

org.xwiki.tool.xar.Transformation

public class Transformation
extends Object

Hold Transformation configuration as specified by the user in its pom.xml.

Since:

5.3M1

Version:

$Id: 6d0058819516c0f23f3d04d56ab0e3e264caeaf6 $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Transformation.Action The action to apply.

Constructor Summary

Constructors

Constructor and Description
Transformation()

Method Summary

Modifier and Type	Method and Description
Transformation.Action	getAction()
String	getArtifact()
String	getFile()
String	getValue()
File	getXml()
String	getXpath()
void	setAction(Transformation.Action action)
void	setArtifact(String artifact)
void	setFile(String file)
void	setValue(String value)
void	setXml(File xml)
void	setXpath(String xpath)

Methods inherited from class java.lang.Object

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

Constructor Detail

Transformation

public Transformation()

Method Detail

getAction

public Transformation.Action getAction()

Returns:

the action to apply

Since:

9.5RC1

setAction

public void setAction(Transformation.Action action)

Parameters:

action - the action to apply

Since:

9.5RC1

getArtifact

public String getArtifact()

Returns:

the optional id (in the format groupId:artifactId of the dependent XAR artifact where the page to be transformed is located. If not specified then the page is considered to be in the current project

setArtifact

public void setArtifact(String artifact)

Parameters:

artifact - see getArtifact()

getFile

public String getFile()

Returns:

the path relative to the target/classes directory of the XML file for which to apply a transformation

setFile

public void setFile(String file)

Parameters:

file - see getFile()

getXpath

public String getXpath()

Returns:

the XPath expression to locate the node for which to change the text value

setXpath

public void setXpath(String xpath)

Parameters:

xpath - see getXpath()

getValue

public String getValue()

Returns:

the new value to set for the node specified by the XPath expression. Note that $1 tokens are replaced by the current value

setValue

public void setValue(String value)

Parameters:

value - see getValue()

getXml

public File getXml()

Returns:

the file containing the XML to insert

Since:

9.5RC1

setXml

public void setXml(File xml)

Parameters:

xml - the file containing the XML to insert

Since:

9.5RC1