public interface DitaMapCompareProgressListener
At the map-level, Start and Finish callback events occur for the following steps:
At the topic-level, for each topic, the following callback events occur:
At the topic-comparison level, for each topic comparison, the following callback events occur:
Modifier and Type | Interface and Description |
---|---|
static class |
DitaMapCompareProgressListener.DocumentSource
Specifies the A or B source document map.
|
static class |
DitaMapCompareProgressListener.ProcessingMode
The mode in which topics are processed.
|
Modifier and Type | Method and Description |
---|---|
void |
inputMapCopyFinish(DitaMapCompareProgressListener.DocumentSource source,
java.lang.String sourceHref,
java.lang.String destinationHref)
Report when the input map copy is completed.
|
void |
inputMapCopyStart(DitaMapCompareProgressListener.DocumentSource source,
java.lang.String sourceHref,
java.lang.String destinationBaseHref)
Report when the input map copy starts.
|
void |
inputMapScanFinish(DitaMapCompareProgressListener.DocumentSource source,
java.lang.String sourceHref,
int foundTopicsCount)
Report when the scan for the topics referenced (directly or indirectly) from the input map has completed.
|
void |
inputMapScanStart(DitaMapCompareProgressListener.DocumentSource source,
java.lang.String sourceHref)
Report when the scan for the topics referenced (directly or indirectly) from the input map has started.
|
void |
mapLevelOutputProcessingFinish()
Report when the updates to the final result map(s) have completed.
|
void |
mapLevelOutputProcessingStart()
Report when the updates to the final result map(s) have started.
|
void |
processingTopicFailure(java.lang.String href,
DitaMapCompareProgressListener.ProcessingMode processMode,
java.lang.Exception exception)
Report when a failure happens during the processing of a topic.
|
void |
processingTopicFinish(java.lang.String href,
DitaMapCompareProgressListener.ProcessingMode processMode)
Report when the processing of a topic has finished.
|
void |
processingTopicStart(java.lang.String href,
DitaMapCompareProgressListener.ProcessingMode processMode)
Report when the processing of a topic has started.
|
void |
topicAlignmentFinish(java.util.Map<java.lang.String,java.lang.String> alignedTopics,
java.util.Set<java.lang.String> unalignedTopicsA,
java.util.Set<java.lang.String> unalignedTopicsB)
Report when topic alignment process completed.
|
void |
topicAlignmentStart()
Report when topic alignment process started.
|
void |
topicCompareCompleted(java.lang.String href,
int stagesStarted,
int stagesCompleted,
java.lang.String stageDescription)
Report when each topic comparison stage has been completed.
|
void |
topicCompareStageHeartbeat(java.lang.String href)
Report heartbeats when inside the compare stage.
|
void |
topicCompareStages(java.lang.String href,
int totalNumberOfStages)
Report the total number of topic comparison stages that are involved in performing the comparison.
|
void |
topicCompareStarted(java.lang.String href,
int stagesStarted,
int stagesCompleted,
java.lang.String stageDescription)
Report when each topic comparison stage has been started.
|
void inputMapCopyStart(DitaMapCompareProgressListener.DocumentSource source, java.lang.String sourceHref, java.lang.String destinationBaseHref)
source
- indicates whether it is the A or B input.sourceHref
- the URI of the source map.destinationBaseHref
- the URI of the output directory.void inputMapCopyFinish(DitaMapCompareProgressListener.DocumentSource source, java.lang.String sourceHref, java.lang.String destinationHref)
source
- indicates whether it is the A or B input.sourceHref
- the URI of the source map.destinationHref
- the URI of the map copy destination.void inputMapScanStart(DitaMapCompareProgressListener.DocumentSource source, java.lang.String sourceHref)
source
- indicates whether it is the A or B input.sourceHref
- the URI of the source map.void inputMapScanFinish(DitaMapCompareProgressListener.DocumentSource source, java.lang.String sourceHref, int foundTopicsCount)
source
- indicates whether it is the A or B input.sourceHref
- the URI of the source map.foundTopicsCount
- the number of topics referenced.void topicAlignmentStart()
void topicAlignmentFinish(java.util.Map<java.lang.String,java.lang.String> alignedTopics, java.util.Set<java.lang.String> unalignedTopicsA, java.util.Set<java.lang.String> unalignedTopicsB)
Provides alignment information on referenced topics, giving an indication of the number of comparisons to be performed - the size of the alignedTopics Map.
alignedTopics
- pairs of A, B topics aligned for comparison.unalignedTopicsA
- topics identified as deleted.unalignedTopicsB
- topics identified as inserted.void processingTopicStart(java.lang.String href, DitaMapCompareProgressListener.ProcessingMode processMode)
href
- the URI of the topic being processed.processMode
- how the topic is being processed.void processingTopicFinish(java.lang.String href, DitaMapCompareProgressListener.ProcessingMode processMode)
href
- the URI of the topic processed.processMode
- how the topic was processed.void processingTopicFailure(java.lang.String href, DitaMapCompareProgressListener.ProcessingMode processMode, java.lang.Exception exception)
href
- the URI of the topic processed.processMode
- how the topic was being processed.exception
- the exception raised whilst processing the topicvoid topicCompareStages(java.lang.String href, int totalNumberOfStages)
href
- the URI of the topic processed.totalNumberOfStages
- the total number of stages that are involved in performing the comparison.void topicCompareStarted(java.lang.String href, int stagesStarted, int stagesCompleted, java.lang.String stageDescription)
href
- the URI of the topic processed.stagesStarted
- the number of Stages that have been started.stagesCompleted
- the number of Stages that have been completed.stageDescription
- the description of the started stage.void topicCompareCompleted(java.lang.String href, int stagesStarted, int stagesCompleted, java.lang.String stageDescription)
href
- the URI of the topic processed.stagesStarted
- the number of Stages that have been started.stagesCompleted
- the number of Stages that have been completed.stageDescription
- the description of the completed stage.void topicCompareStageHeartbeat(java.lang.String href)
Notes:
href
- the URI of the topic processed.void mapLevelOutputProcessingStart()
void mapLevelOutputProcessingFinish()
Copyright © 2001-2016 DeltaXML Ltd. All Rights Reserved.