DTCP Schema Guide

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

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

Element: advancedConfig 2

Configuration options providing low-level control of the comparison, more general configuration options are in 'standardConfig'

Contained by

Contains

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

Contains

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

Contains

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

Contains

Element: standardConfig 6

Genaral configuration options for the DataComparator - see 'advancedConfig' for further options.

Contained by

Contains

Element: outputProperties 7

Set Serializer property settings for the built in Saxon Serializer.

Contained by

Contains

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

Contains

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

Contains

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

Contains

Element: inputExtensionPoints 11

Extension points for modifying A and B input filters

Contained by

Contains

Element: outputExtensionPoints 12

Extension points for modifying output filter chains.

Contained by

Contains

Element: booleanParameter 13

Declare a boolean parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions.

Contained by

Contains

Element: stringParameter 14

Declare a string parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions.

Contained by

Contains

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

Contains

Element: comparisonReport 16

Specifies whether and where to generate comparison report which contains comparison analysis and recommendations to improve comparison result.

Contained by

Contains

Element: ignoreChangesConfig 17

Specifies configuration options for Ignore Changes processing.

These options can be specified on a comparator to configure its behaviour.

Contained by

Contains

Element: moveDetectionConfig 18

Specifies configuration options for moves.

These configuration options can be specified on a comparator to configure its behaviour.

Contained by

Contains

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

Contains

Element: resultReadabilityOptions 20

Sets options to change the granularity and ordering of changes in the result in order to improve readability.

Contained by

Contains

Element: subtreeProcessingMode 21

Specifies configuration options for subtree processing.

These options can be specified on a comparator to configure its behaviour.

Contained by

Contains

Element: property 22

Sets the string value of a named property

Contained by

Contains

Element: feature 23

Sets the boolean value of a named feature.

Contained by

Contains

Element: booleanProperty 24

A named boolean property

Contained by

Contains

Element: stringProperty 25

A named string property

Contained by

Contains

Element: inputPoint 26

Extension point for modifying A and B input filters, after element flattening.

Contained by

Contains

Element: inputPreFlatteningPoint 27

Extension point for modifying A and B input filters, before element flattening.

Contained by

Contains

Element: finalPoint 28

Final filter extension point in the DataComparator output pipeline.

Contained by

Contains

Element: description 29

Short summary of the purpose of the parameter.

Contained by

Contains

Type: xs:string

Element: attributeLocations 30

This class is used to represent locations for attributes which will be processed and split.

Contained by

Contains

Element: isEnabled 31

Sets whether the comparator should enable the feature or not.

Contained by

Contains

Element: generateReport 32

Specifies whether to generate comparison report.

Contained by

Contains

Element: reportDirectory 33

Specifies where to generate comparison report.

Contained by

Contains

Element: locations 34

This class is used to represent locations for elements and attributes on which the changes will be ignored.

Contained by

Contains

Element: moveCandidates 35

This class is used to represent move candidates.

Contained by

Contains

Element: moveDetectionType 36

Sets the type of move detection, determining how move processing should be executed.

Contained by

Contains

Element: showMoveSource 37

Sets whether the comparator should show move source or not.

Contained by

Contains

Element: defaultNamespace 38

This element is used to define the default namespace.

Contained by

Contains

Element: userNamespaces 39

This element is used to define user namespaces.

Contained by

Contains

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

Contains

Element: characterByCharacterEnabled 41

Sets whether to enable character by character comparison

Contained by

Contains

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

Contains

Element: elementSplittingThreshold 43

Sets the percentage of unchanged text present in a modified element below which the element will be split.

Contained by

Contains

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

Contains

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

Contains

Element: orphanedWordDetectionEnabled 46

States whether or not orphaned word detection is enabled.

Contained by

Contains

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

Contains

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

Contains

Element: subtrees 49

This class is used to represent subtrees.

Contained by

Contains

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

Contains

Element: attributeLocation 51

This is used to represent an attribute location XPath, separator, regular expression or output separator.

Contained by

Contains

Element: location 52

This is used to represent location XPath and result rule.

Contained by

Contains

Element: moveCandidate 53

This is used to represent move candidate element XPath and class XPath pairs.

Contained by

Contains

Element: userNamespace 54

This element is used to define user namespace.

Contained by

Contains

Element: subtree 55

This is used to represent subtree XPath and type.

Contained by

Contains

Element: class 56

Load a Java class implementing the SAX XMLFilter interface from the ClassPath.

Contained by

Contains

Element: file 57

Load an XSLT filter from the file system.

Contained by

Contains

Element: http 58

Load XSLT filter from an identified HTTP resource.

Contained by

Contains

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

Contains

Element: resource 60

Load an XSLT filter as a resource in a jar file.

Contained by

Contains

Element: childAlignment 61

This class represents child alignment specifiers for the subtree configuration.

Contained by

Contains

This documentation was auto-generated from the XML Schema XSD.