org.jboss.windup.rules.apps.xml.condition

Class XmlFile

java.lang.Object

org.ocpsoft.rewrite.config.DefaultConditionBuilder

org.jboss.windup.config.condition.GraphCondition

org.jboss.windup.config.parameters.ParameterizedGraphCondition

org.jboss.windup.rules.apps.xml.condition.XmlFile

All Implemented Interfaces:

XmlFileDTD, XmlFileIn, XmlFileNamespace, XmlFileResult, XmlFileXpath, org.ocpsoft.rewrite.config.Condition, org.ocpsoft.rewrite.config.ConditionBuilder, org.ocpsoft.rewrite.param.Parameterized

public class XmlFile
extends ParameterizedGraphCondition
implements XmlFileDTD, XmlFileIn, XmlFileNamespace, XmlFileResult, XmlFileXpath

Handles matching on XmlFileModel objects and creating/returning XmlTypeReferenceModel or XmlFileModel objects on the matching nodes/whole files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XmlFile.XmlFileEvaluationStrategy

Constructor Summary

Constructors

Constructor and Description
XmlFile()

Method Summary

Modifier and Type	Method and Description
XmlFileDTD	andDTDPublicId(String publicIdRegex) Specify the DTD public-id regex.
XmlFileDTD	andDTDSystemId(String dtdNamespace) Specify the DTD system-id regex.
org.ocpsoft.rewrite.config.ConditionBuilder	as(String variable) Output the results using the provided variable name.
protected boolean	evaluateAndPopulateValueStores(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, FrameCreationContext frameCreationContext)
protected boolean	evaluateWithValueStore(GraphRewrite event, org.ocpsoft.rewrite.context.EvaluationContext context, FrameContext frameContext)
static XmlFileFrom	from(String fromVariable) Specify the name of the variables to base this query on.
org.ocpsoft.rewrite.param.RegexParameterizedPatternParser	getInFilePattern()
String	getPublicId()
Set<String>	getRequiredParameterNames()
protected String	getVarname()
XPathExpression	getXPathExpression()
String	getXpathString()
XmlFileIn	inFile(String fileName) Scan only files that match the given file name.
static XmlFileXpath	matchesXpath(String xpath) Create a new XmlFile Condition.
XmlFileNamespace	namespace(String prefix, String url) Specify the namespace used in the xpath that was provided sooner.
XmlFileResult	resultMatches(String regex) Only return results that match the given regex.
void	setParameterStore(org.ocpsoft.rewrite.param.ParameterStore store)
void	setXpath(String xpath)
void	setXpathResultMatch(String xpathResultMatch)
String	toString()
static XmlFileDTD	withDTDSystemId(String dtdNamespace) Create a new XmlFile that matches on the provided DTD namespace.

Methods inherited from class org.jboss.windup.config.parameters.ParameterizedGraphCondition

evaluate

Methods inherited from class org.jboss.windup.config.condition.GraphCondition

evaluate, getInputVariablesName, getOutputVariablesName, setInputVariablesName, setOutputVariablesName, setResults

Methods inherited from class org.ocpsoft.rewrite.config.DefaultConditionBuilder

and, andNot, or, orNot

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ocpsoft.rewrite.config.ConditionBuilder

and, andNot, or, orNot

Methods inherited from interface org.ocpsoft.rewrite.config.Condition

evaluate

Constructor Detail

XmlFile

public XmlFile()

Method Detail

setXpathResultMatch

public void setXpathResultMatch(String xpathResultMatch)

getXpathString

public String getXpathString()

matchesXpath

public static XmlFileXpath matchesXpath(String xpath)

Create a new XmlFile Condition.

andDTDPublicId

public XmlFileDTD andDTDPublicId(String publicIdRegex)

Description copied from interface: XmlFileResult

Specify the DTD public-id regex.

Specified by:

andDTDPublicId in interface XmlFileResult

Specified by:

andDTDPublicId in interface XmlFileXpath

Parameters:

publicIdRegex - public-id regex

Returns:

withDTDSystemId

public static XmlFileDTD withDTDSystemId(String dtdNamespace)

Create a new XmlFile that matches on the provided DTD namespace.

andDTDSystemId

public XmlFileDTD andDTDSystemId(String dtdNamespace)

Description copied from interface: XmlFileXpath

Specify the DTD system-id regex.

Specified by:

andDTDSystemId in interface XmlFileXpath

Parameters:

dtdNamespace - system-id regex

Returns:

as

public org.ocpsoft.rewrite.config.ConditionBuilder as(String variable)

Output the results using the provided variable name.

Specified by:

as in interface XmlFileDTD

Specified by:

as in interface XmlFileIn

Specified by:

as in interface XmlFileNamespace

Specified by:

as in interface XmlFileResult

Specified by:

as in interface XmlFileXpath

Parameters:

variable - variable name that will be saved in stack as the output of this condition.

Returns:

inFile

public XmlFileIn inFile(String fileName)

Scan only files that match the given file name.

Specified by:

inFile in interface XmlFileDTD

Specified by:

inFile in interface XmlFileResult

Specified by:

inFile in interface XmlFileXpath

Parameters:

fileName - regex of file name

Returns:

resultMatches

public XmlFileResult resultMatches(String regex)

Only return results that match the given regex.

Specified by:

resultMatches in interface XmlFileXpath

Parameters:

regex - that should the xpath result match

Returns:

getXPathExpression

public XPathExpression getXPathExpression()

getInFilePattern

public org.ocpsoft.rewrite.param.RegexParameterizedPatternParser getInFilePattern()

getPublicId

public String getPublicId()

from

public static XmlFileFrom from(String fromVariable)

Specify the name of the variables to base this query on.

Parameters:

fromVariable -

Returns:

setParameterStore

public void setParameterStore(org.ocpsoft.rewrite.param.ParameterStore store)

Specified by:

setParameterStore in interface org.ocpsoft.rewrite.param.Parameterized

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

Specified by:

getRequiredParameterNames in interface org.ocpsoft.rewrite.param.Parameterized

getVarname

protected String getVarname()

Specified by:

getVarname in class ParameterizedGraphCondition

evaluateAndPopulateValueStores

protected boolean evaluateAndPopulateValueStores(GraphRewrite event,
                                                 org.ocpsoft.rewrite.context.EvaluationContext context,
                                                 FrameCreationContext frameCreationContext)

Specified by:

evaluateAndPopulateValueStores in class ParameterizedGraphCondition

evaluateWithValueStore

protected boolean evaluateWithValueStore(GraphRewrite event,
                                         org.ocpsoft.rewrite.context.EvaluationContext context,
                                         FrameContext frameContext)

Specified by:

evaluateWithValueStore in class ParameterizedGraphCondition

namespace

public XmlFileNamespace namespace(String prefix,
                                  String url)

Description copied from interface: XmlFileDTD

Specify the namespace used in the xpath that was provided sooner. Use this only if you don't want to specify file regex of the file.

Specified by:

namespace in interface XmlFileDTD

Specified by:

namespace in interface XmlFileIn

Specified by:

namespace in interface XmlFileNamespace

Specified by:

namespace in interface XmlFileResult

Specified by:

namespace in interface XmlFileXpath

Parameters:

prefix - the namespace prefix

url - the namespace url

Returns:

the last step in XmlFile definition to provide the variable name

setXpath

public void setXpath(String xpath)

toString

public String toString()

Overrides:

toString in class Object