com.helger.schematron.pure.binding.xpath

Class PSXPathQueryBinding

java.lang.Object

com.helger.schematron.pure.binding.xpath.PSXPathQueryBinding

All Implemented Interfaces:

IPSQueryBinding, Serializable

public class PSXPathQueryBinding
extends Object
implements IPSQueryBinding

Default XPath/XSLT query binding

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	PARAM_VARIABLE_PREFIX

Method Summary

Modifier and Type	Method and Description
IPSBoundSchema	bind(PSSchema aSchema, String sPhase, IPSErrorHandler aCustomErrorListener)
IPSBoundSchema	bind(PSSchema aSchema, String sPhase, IPSErrorHandler aCustomErrorListener, XPathVariableResolver aVariableResolver, XPathFunctionResolver aFunctionResolver) Create a bound schema, which is like a precompiled schema.
static PSXPathQueryBinding	getInstance()
String	getNegatedTestExpression(String sTest) Negate the passed test statement.
com.helger.commons.collection.ext.ICommonsNavigableMap<String,String>	getStringReplacementMap(List<PSParam> aParams) Convert the passed list of PSParam elements to a map suitable for String replacement.
String	getWithParamTextsReplaced(String sText, Map<String,String> aStringReplacements) Apply the Map created by IPSQueryBinding.getNegatedTestExpression(String) on a single string.
static String	getWithParamTextsReplacedStatic(String sText, Map<String,String> aStringReplacements)

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_VARIABLE_PREFIX

public static final char PARAM_VARIABLE_PREFIX

See Also:

Constant Field Values

Method Detail

getInstance

@Nonnull
public static PSXPathQueryBinding getInstance()

getNegatedTestExpression

@Nonnull
public String getNegatedTestExpression(@Nonnull
                                                 String sTest)

Description copied from interface: IPSQueryBinding

Negate the passed test statement. This is required in the creation of a minified Schematron, when report elements are converted to assert elements.

Specified by:

getNegatedTestExpression in interface IPSQueryBinding

Parameters:

sTest - The test expression.

Returns:

The negated test expression

getStringReplacementMap

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsNavigableMap<String,String> getStringReplacementMap(@Nonnull
                                                                                                                                     List<PSParam> aParams)

Description copied from interface: IPSQueryBinding

Convert the passed list of PSParam elements to a map suitable for String replacement. This is needed to resolve placeholders in abstract patterns. The default query binding e.g. adds a "$" in front of each parameter name. The so created map is used to resolve abstract rule and pattern data to real values.

Specified by:

getStringReplacementMap in interface IPSQueryBinding

Parameters:

aParams - Source list. May not be null.

Returns:

Non-null String replacement map.

getWithParamTextsReplacedStatic

@Nullable
public static String getWithParamTextsReplacedStatic(@Nullable
                                                                String sText,
                                                                @Nullable
                                                                Map<String,String> aStringReplacements)

getWithParamTextsReplaced

@Nullable
public String getWithParamTextsReplaced(@Nullable
                                                   String sText,
                                                   @Nullable
                                                   Map<String,String> aStringReplacements)

Description copied from interface: IPSQueryBinding

Apply the Map created by IPSQueryBinding.getNegatedTestExpression(String) on a single string.
According to iso_abstract_expand.xsl, line 233 the text replacements happen for the following attributes:

• test - only in PSAssertReport
• context - only in PSRule
• select - only in PSValueOf

As an experimental option in line 244 the replacement is also applied to all text nodes. This is currently not supported!

Specified by:

getWithParamTextsReplaced in interface IPSQueryBinding

Parameters:

sText - The original text. May be null.

aStringReplacements - All replacements as map from source to target. The map should be ordered by longest keys first.

Returns:

null if the input string was null.

bind

@Nonnull
public IPSBoundSchema bind(@Nonnull
                                     PSSchema aSchema,
                                     @Nullable
                                     String sPhase,
                                     @Nullable
                                     IPSErrorHandler aCustomErrorListener)
                              throws SchematronException

Throws:

SchematronException

bind

@Nonnull
public IPSBoundSchema bind(@Nonnull
                                     PSSchema aSchema,
                                     @Nullable
                                     String sPhase,
                                     @Nullable
                                     IPSErrorHandler aCustomErrorListener,
                                     @Nullable
                                     XPathVariableResolver aVariableResolver,
                                     @Nullable
                                     XPathFunctionResolver aFunctionResolver)
                              throws SchematronException

Description copied from interface: IPSQueryBinding

Create a bound schema, which is like a precompiled schema.

Specified by:

bind in interface IPSQueryBinding

Parameters:

aSchema - The schema to be bound. May not be null.

sPhase - The phase to use. May be null. If it is null than the defaultPhase is used that is defined in the schema. If no defaultPhase is present, than all patterns are evaluated.

aCustomErrorListener - An optional custom error handler to use. May be null.

aVariableResolver - Custom variable resolver. May be null.

aFunctionResolver - Custom function resolver. May be null.

Returns:

The precompiled, bound schema. Never null.

Throws:

SchematronException - In case of a binding error