This guide provides a short description of each element and attribute defined in the XML schema for the DATACOMPARATOR Pipeline (DTCP). A fuller description of DTCP, along with an example and an explanation of the main concepts can be found in the DTCP User Guide.
Element Index
DTCP Schema Guide | advancedConfig 2
DTCP Schema Guide | attributeLocation 51
DTCP Schema Guide | attributeLocations 30
DTCP Schema Guide | attributeSplittingConfig 15
DTCP Schema Guide | booleanParameter 13
DTCP Schema Guide | booleanProperty 24
DTCP Schema Guide | changeGatheringEnabled 40
DTCP Schema Guide | characterByCharacterEnabled 41
DTCP Schema Guide | childAlignment 61
DTCP Schema Guide | comparisonReport 16
DTCP Schema Guide | dataComparator 1
DTCP Schema Guide | defaultNamespace 38
DTCP Schema Guide | description 29
DTCP Schema Guide | elementSplittingEnabled 42
DTCP Schema Guide | elementSplittingThreshold 43
DTCP Schema Guide | extensionPoints 3
DTCP Schema Guide | feature 23
DTCP Schema Guide | finalPoint 28
DTCP Schema Guide | fullDescription 4
DTCP Schema Guide | generateReport 32
DTCP Schema Guide | ignoreChangesConfig 17
DTCP Schema Guide | inputExtensionPoints 11
DTCP Schema Guide | inputPoint 26
DTCP Schema Guide | inputPreFlatteningPoint 27
DTCP Schema Guide | isEnabled 31
DTCP Schema Guide | location 52
DTCP Schema Guide | locations 34
DTCP Schema Guide | mixedContentDetectionScope 44
DTCP Schema Guide | modifiedWhitespaceBehaviour 45
DTCP Schema Guide | moveCandidate 53
DTCP Schema Guide | moveCandidates 35
DTCP Schema Guide | moveDetectionConfig 18
DTCP Schema Guide | moveDetectionType 36
DTCP Schema Guide | namespaceConfiguration 19
DTCP Schema Guide | orphanedWordDetectionEnabled 46
DTCP Schema Guide | orphanedWordLengthLimit 47
DTCP Schema Guide | orphanedWordMaxPercentage 48
DTCP Schema Guide | outputExtensionPoints 12
DTCP Schema Guide | outputProperties 7
DTCP Schema Guide | parameter 59
DTCP Schema Guide | parserFeatures 8
DTCP Schema Guide | parserProperties 9
DTCP Schema Guide | pipelineParameters 5
DTCP Schema Guide | property 22
DTCP Schema Guide | reportDirectory 33
DTCP Schema Guide | resource 60
DTCP Schema Guide | resultReadabilityOptions 20
DTCP Schema Guide | showMoveSource 37
DTCP Schema Guide | standardConfig 6
DTCP Schema Guide | stringParameter 14
DTCP Schema Guide | stringProperty 25
DTCP Schema Guide | subtree 55
DTCP Schema Guide | subtreeProcessingMode 21
DTCP Schema Guide | subtrees 49
DTCP Schema Guide | transformerConfigurationProperties 10
DTCP Schema Guide | userNamespace 54
DTCP Schema Guide | userNamespaces 39
Element Detail
Elements are listed in document-tree order, top-level elements first, then alphabetically:
Element: dataComparator 1
The root element for defining the overrides to a DataComparator whose defaults are as described in the API documentation.
A Data Comparator instance with default settings is created if no child elements are present.
Contained by
/
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
id |
anyNameType |
A unique identifier for this pipeline configuration - listed as 'configuration id' in the command-line description. |
|
version |
string |
The DTCP specification version this conforms to - fixed at '1.0' |
|
description |
string |
Short description of this DTCP configuration. |
|
Element |
Description |
|
| DTCP Schema Guide | advancedConfig |
Configuration options providing low-level control of the comparison, more general configuration options are in 'standardConfig' |
|
| DTCP Schema Guide | extensionPoints |
Declare the extension points and contained filters to be inserted within the DataComparator pipeline |
|
| DTCP Schema Guide | fullDescription |
Designed to provide meaningful description and basic help information to the user |
|
| DTCP Schema Guide | pipelineParameters |
Container for all pipeline parameters |
|
| DTCP Schema Guide | standardConfig |
Genaral configuration options for the DataComparator - see 'advancedConfig' for further options |
|
Element: advancedConfig 2
Configuration options providing low-level control of the comparison, more general configuration options are in 'standardConfig'
Contained by
/ DTCP Schema Guide | dataComparator
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | outputProperties |
Set Serializer property settings for the built in Saxon Serializer |
|
| DTCP Schema Guide | parserFeatures |
Set features on the underlying SAX parser used in the pipeline |
|
| DTCP Schema Guide | parserProperties |
Set properties on the underlying SAX parser used in the pipeline |
|
| DTCP Schema Guide | transformerConfigurationProperties |
Set configuration option on the Saxon XSLT transformers used in the pipeline |
|
Element: extensionPoints 3
Declare the extension points and contained filters to be inserted within the DataComparator pipeline.
In EBNF the required sequence S of child elements is:
-
S := 'inputPreFlatteningPoint'? IP 'outputExtensionPoints'?
-
IP := 'inputExtensionPoints'? | ( 'inputAExtensionPoints'? 'inputBExtensionPoints'? )
Contained by
/ DTCP Schema Guide | dataComparator
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | inputExtensionPoints |
Extension points for modifying A and B input filters |
|
| DTCP Schema Guide | outputExtensionPoints |
Extension points for modifying output filter chains |
|
Element: fullDescription 4
Designed to provide meaningful description and basic help information to the user.
It can contain PCDATA content. It should include a description of the Data Comparator configuration defined by the DTCP. How this information is presented to users is a tool-dependent operation, for example a GUI-based tool may provide a pop-up window and show HTML formatted content.
Contained by
/ DTCP Schema Guide | dataComparator
Contains
|
Element |
Description |
|
|---|---|---|
|
[any] |
Any element permitted [mixed content] |
|
Element: pipelineParameters 5
Container for all pipeline parameters.
Pipeline parameters have global scope and are referenced using the 'paremeterRef' attribute. Pipeline parameters have a default value that can be overridden through the API. The maximum number of child elements is not restricted.
Contained by
/ DTCP Schema Guide | dataComparator
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | booleanParameter |
Declare a boolean parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions |
|
| DTCP Schema Guide | stringParameter |
Declare a string parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions |
|
Element: standardConfig 6
Genaral configuration options for the DataComparator - see 'advancedConfig' for further options.
Contained by
/ DTCP Schema Guide | dataComparator
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | attributeSplittingConfig |
Specifies configuration options for attribute splitting |
|
| DTCP Schema Guide | comparisonReport |
Specifies whether and where to generate comparison report which contains comparison analysis and recommendations to improve comparison result |
|
| DTCP Schema Guide | ignoreChangesConfig |
Specifies configuration options for Ignore Changes processing |
|
| DTCP Schema Guide | moveDetectionConfig |
Specifies configuration options for moves |
|
| DTCP Schema Guide | namespaceConfiguration |
Defines a set of prefix uri pairs for namespaces that can be used within XPath expressions provided to certain configurations such as ignoreChangesConfig or subtreeProcessingMode |
|
| DTCP Schema Guide | resultReadabilityOptions |
Sets options to change the granularity and ordering of changes in the result in order to improve readability |
|
| DTCP Schema Guide | subtreeProcessingMode |
Specifies configuration options for subtree processing |
|
Element: outputProperties 7
Set Serializer property settings for the built in Saxon Serializer.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | advancedConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | property |
Sets the string value of a named property |
|
Element: parserFeatures 8
Set features on the underlying SAX parser used in the pipeline.
For more detail, see setParserFeature in the API documentation.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | advancedConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | feature |
Sets the boolean value of a named feature |
|
Element: parserProperties 9
Set properties on the underlying SAX parser used in the pipeline.
For more detail, see setParserProperty in the API documentation.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | advancedConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | property |
Sets the string value of a named property |
|
Element: transformerConfigurationProperties 10
Set configuration option on the Saxon XSLT transformers used in the pipeline.
The maximum number of child elements is not restricted.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | advancedConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | booleanProperty |
A named boolean property |
|
| DTCP Schema Guide | stringProperty |
A named string property |
|
Element: inputExtensionPoints 11
Extension points for modifying A and B input filters
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | inputPoint |
Extension point for modifying A and B input filters, after element flattening |
|
| DTCP Schema Guide | inputPreFlatteningPoint |
Extension point for modifying A and B input filters, before element flattening |
|
Element: outputExtensionPoints 12
Extension points for modifying output filter chains.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | finalPoint |
Final filter extension point in the DataComparator output pipeline |
|
Element: booleanParameter 13
Declare a boolean parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | pipelineParameters
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
NCName |
The boolean parameter name |
|
defaultValue |
boolean |
The default boolean value - may be overriden externally |
|
Element |
Description |
|
| DTCP Schema Guide | description |
Short summary of the purpose of the parameter |
|
Element: stringParameter 14
Declare a string parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | pipelineParameters
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
NCName |
The string parameter name |
|
defaultValue |
string |
The default string value - may be overriden externally |
|
Element |
Description |
|
| DTCP Schema Guide | description |
Short summary of the purpose of the parameter |
|
Element: attributeSplittingConfig 15
Specifies configuration options for attribute splitting.
These options can be specified on a comparator to configure its behaviour. Attribute Splitting is off by default.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
defaultMode |
[enum] |
Permitted values / descriptions: narrativeText This mode sets the default mode to narrative text. dataSet This mode sets the default mode to data set. dataList This mode sets the default mode to data list. |
|
Element |
Description |
|
| DTCP Schema Guide | attributeLocations |
This class is used to represent locations for attributes which will be processed and split |
|
| DTCP Schema Guide | isEnabled |
Sets whether the comparator should enable the feature or not |
|
Element: comparisonReport 16
Specifies whether and where to generate comparison report which contains comparison analysis and recommendations to improve comparison result.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | generateReport |
Specifies whether to generate comparison report |
|
| DTCP Schema Guide | reportDirectory |
Specifies where to generate comparison report |
|
Element: ignoreChangesConfig 17
Specifies configuration options for Ignore Changes processing.
These options can be specified on a comparator to configure its behaviour.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | locations |
This class is used to represent locations for elements and attributes on which the changes will be ignored |
|
Element: moveDetectionConfig 18
Specifies configuration options for moves.
These configuration options can be specified on a comparator to configure its behaviour.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | isEnabled |
Sets whether the comparator should enable the feature or not |
|
| DTCP Schema Guide | moveCandidates |
This class is used to represent move candidates |
|
| DTCP Schema Guide | moveDetectionType |
Sets the type of move detection, determining how move processing should be executed |
|
| DTCP Schema Guide | showMoveSource |
Sets whether the comparator should show move source or not |
|
Element: namespaceConfiguration 19
Defines a set of prefix uri pairs for namespaces that can be used within XPath expressions provided to certain configurations such as ignoreChangesConfig or subtreeProcessingMode.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | defaultNamespace |
This element is used to define the default namespace |
|
| DTCP Schema Guide | userNamespaces |
This element is used to define user namespaces |
|
Element: resultReadabilityOptions 20
Sets options to change the granularity and ordering of changes in the result in order to improve readability.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | changeGatheringEnabled |
Sets whether to change the order of consecutive changed items to improve readability |
|
| DTCP Schema Guide | characterByCharacterEnabled |
Sets whether to enable character by character comparison |
|
| DTCP Schema Guide | elementSplittingEnabled |
Sets whether modified elements containing text should be split when the amount of unchanged text falls below a given percentage |
|
| DTCP Schema Guide | elementSplittingThreshold |
Sets the percentage of unchanged text present in a modified element below which the element will be split |
|
| DTCP Schema Guide | mixedContentDetectionScope |
Set the scope to use for determining if each element in the document is of a mixed-content type |
|
| DTCP Schema Guide | modifiedWhitespaceBehaviour |
Set the ModifiedWhitespaceBehaviour to use for changes to whitespace |
|
| DTCP Schema Guide | orphanedWordDetectionEnabled |
States whether or not orphaned word detection is enabled |
|
| DTCP Schema Guide | orphanedWordLengthLimit |
Sets the maximum number of words to consider for orphaned word detection |
|
| DTCP Schema Guide | orphanedWordMaxPercentage |
Sets the maximum proportion of the total change size that orphaned words can take while still being considered orphans |
|
Element: subtreeProcessingMode 21
Specifies configuration options for subtree processing.
These options can be specified on a comparator to configure its behaviour.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
defaultMode |
[enum] |
Permitted values / descriptions: text This mode sets the subtree mode to text. data This mode sets the subtree mode to data. |
|
Element |
Description |
|
| DTCP Schema Guide | subtrees |
This class is used to represent subtrees |
|
Element: property 22
Sets the string value of a named property
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | advancedConfig / DTCP Schema Guide | outputProperties
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | advancedConfig / DTCP Schema Guide | parserProperties
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
anyNameType |
The parameter name |
|
literalValue |
string |
The literal string value |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: feature 23
Sets the boolean value of a named feature.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | advancedConfig / DTCP Schema Guide | parserFeatures
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
boolean |
The literal boolean value for the feature setting. |
|
name |
anyURI |
The fully qualitifed feature name. |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: booleanProperty 24
A named boolean property
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | advancedConfig / DTCP Schema Guide | transformerConfigurationProperties
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
anyNameType |
The parameter name |
|
literalValue |
boolean |
The literal boolean value |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: stringProperty 25
A named string property
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | advancedConfig / DTCP Schema Guide | transformerConfigurationProperties
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
anyNameType |
The parameter name |
|
literalValue |
string |
The literal string value |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: inputPoint 26
Extension point for modifying A and B input filters, after element flattening.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | filter |
An XSLT or Java XML processing filter to be loaded into the comparator pipeline |
|
Element: inputPreFlatteningPoint 27
Extension point for modifying A and B input filters, before element flattening.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | filter |
An XSLT or Java XML processing filter to be loaded into the comparator pipeline |
|
Element: finalPoint 28
Final filter extension point in the DataComparator output pipeline.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | outputExtensionPoints
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | filter |
An XSLT or Java XML processing filter to be loaded into the comparator pipeline |
|
Element: description 29
Short summary of the purpose of the parameter.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | pipelineParameters / DTCP Schema Guide | booleanParameter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | pipelineParameters / DTCP Schema Guide | stringParameter
Contains
Type: xs:string
Element: attributeLocations 30
This class is used to represent locations for attributes which will be processed and split.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | attributeSplittingConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | attributeLocation |
This is used to represent an attribute location XPath, separator, regular expression or output separator |
|
Element: isEnabled 31
Sets whether the comparator should enable the feature or not.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | attributeSplittingConfig
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | moveDetectionConfig
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
boolean |
Set 'true' to enable the feature. |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: generateReport 32
Specifies whether to generate comparison report.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | comparisonReport
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
boolean |
Set 'true' to generate comparison report as an additional output. |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: reportDirectory 33
Specifies where to generate comparison report.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | comparisonReport
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
string |
The location of the directory to write the comparison report to. |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: locations 34
This class is used to represent locations for elements and attributes on which the changes will be ignored.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | ignoreChangesConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | location |
This is used to represent location XPath and result rule |
|
Element: moveCandidates 35
This class is used to represent move candidates.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | moveDetectionConfig
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | moveCandidate |
This is used to represent move candidate element XPath and class XPath pairs |
|
Element: moveDetectionType 36
Sets the type of move detection, determining how move processing should be executed.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | moveDetectionConfig
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
[enum] |
Permitted values / descriptions: restricted This mode only detects moves at the roots of added or deleted subtrees. This may offer a performance benefit in some cases. unrestricted This mode is used to detect moves anywhere in the tree. |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: showMoveSource 37
Sets whether the comparator should show move source or not.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | moveDetectionConfig
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
boolean |
Set 'true' to show move source. |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: defaultNamespace 38
This element is used to define the default namespace.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | namespaceConfiguration
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
uri |
Sets the uri of the default namespace. |
Element: userNamespaces 39
This element is used to define user namespaces.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | namespaceConfiguration
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | userNamespace |
This element is used to define user namespace |
|
Element: changeGatheringEnabled 40
Sets whether to change the order of consecutive changed items to improve readability.
If the result contains a sequence of elements whose deltaxml:deltaV2 attribute values are mixed up in a sequence of As and Bs, enabling this feature will cause them to be reordered so that they are not mixed.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | resultReadabilityOptions
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
boolean |
Set true to enabled change gathering |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: characterByCharacterEnabled 41
Sets whether to enable character by character comparison
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | resultReadabilityOptions
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
boolean |
Set true to enable character by character comparison |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: elementSplittingEnabled 42
Sets whether modified elements containing text should be split when the amount of unchanged text falls below a given percentage.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | resultReadabilityOptions
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
boolean |
Set true to enable element splitting |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: elementSplittingThreshold 43
Sets the percentage of unchanged text present in a modified element below which the element will be split.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | resultReadabilityOptions
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
Percentage |
The threshold percentage as in integer (1 to 100) |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: mixedContentDetectionScope 44
Set the scope to use for determining if each element in the document is of a mixed-content type.
The mixed content type affects whitespace processing. If DTD or XML Schema validation is used this setting has no effect.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | resultReadabilityOptions
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
[enum] |
Permitted values / descriptions: document Determine if an element is mixed-content using information from elements of the same name in the document. Using this scope significantly slows processing for large files. local Determine mixed content information for each element in turn, based on the contents of that element alone. |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: modifiedWhitespaceBehaviour 45
Set the ModifiedWhitespaceBehaviour to use for changes to whitespace.
Here, both documents must have some whitespace at a given point in order for there to be a change in whitespace. This will then be processed in accordance with the specified behaviour. Whitespace insertions and deletions are not affected by the modified whitespace behaviour.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | resultReadabilityOptions
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
[enum] |
Permitted values / descriptions: useDefault The context dependent automatic whitespace setting. ignore Ignore differences in whitespace that is not explicitly preserved. keepA Similar to 'ignore' except that 'A' document's whitespace is kept (instead of the 'B' document's whitespace). normalize Normalize whitespace in inputs before comparison. show Display the differences in whitespace where possible |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: orphanedWordDetectionEnabled 46
States whether or not orphaned word detection is enabled.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | resultReadabilityOptions
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
boolean |
Enable/disable. |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: orphanedWordLengthLimit 47
Sets the maximum number of words to consider for orphaned word detection.
Sequences of words longer than the specified length will never be detected as orphaned words, regardless of the amount of changed words around them.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | resultReadabilityOptions
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
unsignedLong |
|
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: orphanedWordMaxPercentage 48
Sets the maximum proportion of the total change size that orphaned words can take while still being considered orphans.
If the percentage value for a possibly orphaned section is less than or equal to this value, then it is classified as orphaned (unless there are more words than the length limit allows). The percentage value for a possibly orphaned section is calculated as follows:
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | resultReadabilityOptions
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
literalValue |
Percentage |
An integer value (1 to 100) that is the max percentage of the total change size were a change is considered to be orphaned. |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: subtrees 49
This class is used to represent subtrees.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | subtreeProcessingMode
Contains
|
Element |
Description |
|
|---|---|---|
| DTCP Schema Guide | subtree |
This is used to represent subtree XPath and type |
|
Element: filter 50
An XSLT or Java XML processing filter to be loaded into the comparator pipeline.
There must be one 'class', 'http', 'resource' or 'file' child element for a filter element as this defines the filter type and how it is to be loaded. Attributes on the filter element may be used to control whether the filter is enabled or disabled.
Child 'parameter' elements may also be added so that parameter values are passed on to matching parameters in the XML filter. Any number of filter elements may be added to an extension point, filters are processed in the pipeline in order of occurrence.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPoint
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPreFlatteningPoint
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | outputExtensionPoints / DTCP Schema Guide | finalPoint
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
if |
NCName |
Enable filter when named boolean pipelineParameter is true. |
|
unless |
NCName |
Disable filter when named boolean pipelineParameter is true. |
|
when |
string |
Enable filter when XPath expression evaluates true. |
|
Element |
Description |
|
| DTCP Schema Guide | class |
Load a Java class implementing the SAX XMLFilter interface from the ClassPath |
|
| DTCP Schema Guide | file |
Load an XSLT filter from the file system |
|
| DTCP Schema Guide | http |
Load XSLT filter from an identified HTTP resource |
|
| DTCP Schema Guide | parameter |
A named parameter to supply to a filter - any XPath-item type (including a sequence) can be supplied to an XSLT filter using the xpath attribute |
|
| DTCP Schema Guide | resource |
Load an XSLT filter as a resource in a jar file |
|
Element: attributeLocation 51
This is used to represent an attribute location XPath, separator, regular expression or output separator.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | attributeSplittingConfig / DTCP Schema Guide | attributeLocations
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
enabled |
boolean |
Set if attribute splitting is enabled or disabled for the attribute at this location |
|
attributeXpath |
Set the attribute XPath |
|
|
mode |
[enum] |
Permitted values / descriptions: narrativeText This mode sets the default mode to narrative text. dataSet This mode sets the default mode to data set. dataList This mode sets the default mode to data list. |
|
separator |
string |
Sets the separator used to split the attribute text. |
|
regex |
string |
Sets the regular expression used to split the attribute text. |
|
outputTokenSeparator |
string |
Sets the output separator used to separate tokens in the output. |
Element: location 52
This is used to represent location XPath and result rule.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | ignoreChangesConfig / DTCP Schema Guide | locations
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
ignoreXpath |
Sets the node XPath. |
|
|
resultRule |
[enum] |
Permitted values / descriptions: BA Default. This copies new value if it exists, otherwise copy old value. AB This copies old value if it exists, otherwise copy new value. A This copies old value if it exists, otherwise don’t output. B This copies new value if it exists, otherwise don’t output DELETE Don’t copy under any circumstances (but process the subtree if present) |
Element: moveCandidate 53
This is used to represent move candidate element XPath and class XPath pairs.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | moveDetectionConfig / DTCP Schema Guide | moveCandidates
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
elemXpath |
Sets the element Xpath. |
|
|
classXpath |
Sets the class Xpath. |
Element: userNamespace 54
This element is used to define user namespace.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | namespaceConfiguration / DTCP Schema Guide | userNamespaces
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
prefix |
Sets the prefix of the user namespace. |
|
|
uri |
Sets the uri of the user namespace. |
Element: subtree 55
This is used to represent subtree XPath and type.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | subtreeProcessingMode / DTCP Schema Guide | subtrees
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
elemXpath |
Sets the element XPath. |
|
|
mode |
[enum] |
Permitted values / descriptions: text This mode sets the subtree mode to text. data This mode sets the subtree mode to data. |
|
ordered |
boolean |
Sets the boolean where true represents ordered alignment, and false represents unordered alignment. |
|
Element |
Description |
|
| DTCP Schema Guide | childAlignment |
This class represents child alignment specifiers for the subtree configuration |
|
Element: class 56
Load a Java class implementing the SAX XMLFilter interface from the ClassPath.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPreFlatteningPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | outputExtensionPoints / DTCP Schema Guide | finalPoint / DTCP Schema Guide | filter
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
anyNameType |
The fully qualified name of the class. |
Element: file 57
Load an XSLT filter from the file system.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPreFlatteningPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | outputExtensionPoints / DTCP Schema Guide | finalPoint / DTCP Schema Guide | filter
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
path |
string |
The path of the filter to be loaded, relative paths are resolved according to the setting of the 'relBase' attribute. |
|
relBase |
[enum] |
The relBase attribute is used to specify how the relative path to a file is resolved. Permitted values / descriptions: current Resolve using the current working directory, obtained from the Java user.dir system property. home Resolve using the user's home directory. dxp Resolve using the directory containing the DXP file, when it is loaded from a file. |
Element: http 58
Load XSLT filter from an identified HTTP resource.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPreFlatteningPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | outputExtensionPoints / DTCP Schema Guide | finalPoint / DTCP Schema Guide | filter
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
url |
anyURI |
The URL of the HTTP resource. |
Element: parameter 59
A named parameter to supply to a filter - any XPath-item type (including a sequence) can be supplied to an XSLT filter using the xpath attribute.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPreFlatteningPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | outputExtensionPoints / DTCP Schema Guide | finalPoint / DTCP Schema Guide | filter
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
anyNameType |
The parameter name |
|
literalValue |
string |
The literal string value |
|
parameterRef |
string |
Name of referenced pipelineParameter |
|
xpath |
XPath expression returning the required type |
Element: resource 60
Load an XSLT filter as a resource in a jar file.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | inputExtensionPoints / DTCP Schema Guide | inputPreFlatteningPoint / DTCP Schema Guide | filter
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | extensionPoints / DTCP Schema Guide | outputExtensionPoints / DTCP Schema Guide | finalPoint / DTCP Schema Guide | filter
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
anyNameType |
The resource name, for example, '/xsl/resource.xsl' |
Element: childAlignment 61
This class represents child alignment specifiers for the subtree configuration.
Contained by
/ DTCP Schema Guide | dataComparator / DTCP Schema Guide | standardConfig / DTCP Schema Guide | subtreeProcessingMode / DTCP Schema Guide | subtrees / DTCP Schema Guide | subtree
Contains
|
Attribute |
Type |
Description |
|---|---|---|
|
childXpath |
Sets the child xpath |
|
|
keyXpath |
Sets the key xpath specifying the key for the associated child element |
This documentation was auto-generated from the XML Schema XSD.