| Interface | Description |
|---|---|
| DitaCompareDisplayable |
An interface to provide user-friendly names and descriptions for Enum parameter values.
|
| DitaMapCompareProgressListener |
A map comparison progress listener.
|
| DitaMapfileCompareProgressListener |
A comparison progress listener.
|
| DitaTopicCompareProgressListener |
A comparison progress listener.
|
| Class | Description |
|---|---|
| AttributeWithValue |
Represents an XML Attribute name and value pair.
|
| ConfigProperties |
DeltaXML's configuration properties are used to control the behaviour of DeltaXML products.
|
| DitaCompare |
Compares two Darwin Information Typing Architecture (DITA) topics or maps and produces a result topic or map marked to show
changes.
|
| DitaCompareVersion |
The product's version information.
|
| DitaMapCompareProgressListenerAbstractImpl |
A base implementation of the DitaMapCompareProgressListener.
|
| DitaMapfileCompare |
Compares the XML content of two Darwin Information Typing Architecture (DITA) maps and produces a result map marked to show
changes.
|
| DitaMapTopicsetCompare |
Compares two Darwin Information Typing Architecture (DITA) maps and produces a result map(s) marked to show changes.
|
| DitaTopicCompare |
Compares two Darwin Information Typing Architecture (DITA) topics and produces a result topic marked to show changes.
|
| Enum | Description |
|---|---|
| DitaMapCompareProgressListener.DocumentSource |
Specifies the A or B source document map.
|
| DitaMapCompareProgressListener.ProcessingMode |
The mode in which topics are processed.
|
| FrameMakerTrackChangesTableChangeMode |
Enumeration representing the possible values for the framemaker-tcs-table-change-mode parameter.
|
| IndentOutput |
Enumeration representing the possible values for the indent output parameter.
|
| InvalidReferencedSVGBehaviour |
An enum representing the Invalid Referenced SVG Behaviour modes.
|
| InvalidTableBehaviour |
An enum representing the action which should be taken when an invalid table is detected.
|
| MapCleanTemp |
Enumeration representing how the result map is constructed.
|
| MapCopyScope |
Enumeration representing a DITA map's copy scope.
|
| MapResultOrigin |
Enumeration representing which map input is being used to form the basis of the output.
|
| MapResultStructure |
Enumeration representing how the result map is constructed.
|
| MapTopicExceptionPropagationMode |
Enumeration representing what action to perform when there is an exception raised during the processing of a topic.
|
| MapUncomparedTopicMarkup |
Enumeration representing what updates should be performed to uncompared/unaligned topics (in the context of a DITA map
comparison).
|
| MathMLGranularity |
Specifies the granularity at which the differences between the two MathML expressions will be represented from the
DocumentComparator.
|
| ModifiedAttributeMode |
Defined the modified attribute processing mode.
|
| OutputFormat |
Enumeration representing the possible values for the output-format parameter.
|
| OutputImageRefForm |
The result document may reside in a different location to the inputs.
|
| OxygenTrackChangesDeletedSpaceMode |
Enumeration representing the possible values for the oxygen-tcs-deleted-space-mode parameter.
|
| PreservationMode |
An enum representing the different document preservation modes.
|
| ShowNonPhraseChanges |
Enumeration representing how to show changes in elements where phrase would be invalid DITA.
|
| StepsConflictResolution |
Enumeration representing the possible values for the step conflict resolution parameter.
|
| SVGGranularity |
Specifies the granularity at which the differences between two SVG images will be represented.
|
| UnmarkedChangeMode |
Choose the version of the item to extract for output.
|
| UnrepresentableTableRowChangeMode |
Enumeration representing the possible values for the xmetal-tcs-table-change-mode parameter.
|
| WarningReportMode |
An enum representing the warning report modes.
|
| WhitespaceProcessingMode |
Enumeration representing the possible values for the whitespace-processing-mode parameter.
|
| XmetalTrackChangesTableChangeMode |
Enumeration representing the possible values for the xmetal-tcs-table-change-mode parameter.
|
| XmlVersionDeclaration |
Represents the values for the version in the XML declaration.
|
| Exception | Description |
|---|---|
| CPUCountException |
An exception indicating that the license used with the software does not support the number of runtime cores being used.
|
| CPULimitException |
An exception indicating that the license used with the software does not support the number of runtime cores being used.
|
| DeltaXMLDitaException |
Specifies an exceptional condition in the DITA Comparator.
|
| DifferentRootElementException |
Indicates that the inputs have different root elements.
|
| DitaIOException |
DITA Input/Output Exceptions.
|
| DitaTopicProcessingException |
DITA Topic Processing Exception.
|
| FilterProcessingException |
Indicates an error in compiling, configuring or running a filter.
|
| InputLoadException |
Indicates that an input could not be loaded.
|
| InvalidInputException |
Indicates that an input is not of the correct format for this pipeline.
|
| InvalidLicenseException |
An exception indicating that the wrong type of license was found at runtime.
|
| LicenseConcurrencyLimitException |
An exception indicating that the server-controlled concurrency limit has been exceeded.
|
| LicenseContentException |
An exception indicating that the there was a problem with the license used with the software.
|
| LicenseException |
Indicates that the comparison could not be run due to licensing constraints.
|
| LicenseExpiredException |
An exception indicating that the license used with the software has expired.
|
| LicenseNotYetValidException |
An exception indicating that this license has not yet started
|
| LicenseSecurityException |
An exception indicating a problem with the licensing or other security related aspects of the DeltaXML software when the JVM is
using a Security Manager.
|
| NodeCapacityExceededException |
The size of the input data exceeds the capacity permitted by the license.
|
| NoLicenseInstalledException |
An exception indicating that the software cannot find an appropriate license.
|
| ParserException |
Indicates a problem creating or configuring an XML Parser.
|
| PerformMarkupException |
The exception that gets thrown if the perform markup operations abnormally terminate.
|
| SerializationException |
Indicates a problem with writing the comparison result.
|
| Error | Description |
|---|---|
| DeltaXMLDitaError |
Indicates an unrecoverable error condition in the DeltaXML DITA Comparator.
|
The public classes within this package provide the DeltaXML DITA Compare product's API (Application Programming Interface). It
is recommended that you start with one of the DitaCompare,
DitaTopicCompare, DitaMapfileCompare and
DitaMapTopicsetCompare classes, which enable DITA documents, individual topics, individual maps and
map-aligned topic-sets to be compared respectively.
The DitaMapTopicsetCompare class provides a file based comparison of the topics within two maps.
Here, the topics within the input maps are aligned for a pairwise topic level comparison. And the results of this comparison
are then presented in a map, using one of three available 'map result structures': topic-set, map-pair, and unified-map, as set
by the setMapResultStructure method.
Correctly aligning the topics when performing a map driven topic comparison is, in general, a difficult problem. However, there are some common sub-classes of this problem that are more tractable. For example, consider the context where a DITA document (and all of its source) are kept within a directory tree on the file system and document versioning is done by copying this directory. In this context the two DITA documents can be compared by gathering the relative paths from the top-level maps to each of the referenced DITA-topics, and comparing those topics that have the same relative paths. This is the default approach taken by the map comparator.
When using the default topic alignment approach it is possible to identify both the insertion of new topics and the deletion of old topics. However, it is not possible to handle topics whose relative location has changed. Therefore, a future version of this interface will provide a means of supplying a custom topic alignment algorithm.
Copyright © 2001-2016 DeltaXML Ltd. All Rights Reserved.