Package ro.sync.diff.api

Interface AuthorDiffChangeTrackingMerger

  • @API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorDiffChangeTrackingMerger
    Extracts the differences reported when comparing two XML documents ('Two-Way' Author comparison mode) as a document with change tracking, which can be used to review the differences and merge the two documents. Access to the resulting document is provided through a Reader for its content.
    Since:
    26.1

    **************************************
    EXPERIMENTAL - Subject to change
    **************************************

    Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.io.Reader getMergeResultsReader​(java.net.URL baseDocSysID, java.io.Reader baseDocReader, java.net.URL docToMergeWithSysID, java.io.Reader docToMergeWithReader, DiffOptions diffOptions)
      Gets the results of the comparison between two XML documents ('Two-Way' Author comparison mode) as a Reader for the contents of the resulted document with change tracking, which can be used to review the differences and merge the two documents.
      Important note: If the documents to be compared already contain tracked changes, all such changes are automatically accepted before the comparison and the generation of the resulting document.
      void setNameOfAuthorOfChangeTrackingMarkers​(java.lang.String authorName)
      Sets the name of the author of the change tracking markers created in the merged document.

    • Method Detail

      • getMergeResultsReader

        java.io.Reader getMergeResultsReader​(java.net.URL baseDocSysID,
                                     java.io.Reader baseDocReader,
                                     java.net.URL docToMergeWithSysID,
                                     java.io.Reader docToMergeWithReader,
                                     DiffOptions diffOptions)
                              throws DiffException
        Gets the results of the comparison between two XML documents ('Two-Way' Author comparison mode) as a Reader for the contents of the resulted document with change tracking, which can be used to review the differences and merge the two documents.
        Important note: If the documents to be compared already contain tracked changes, all such changes are automatically accepted before the comparison and the generation of the resulting document.
        Parameters:
        baseDocSysID - The system ID of the base document.
          Can be null, but only in case of baseDocReader provided.
        baseDocReader - The Reader for the base document.
          If null and baseDocSysID provided, the reader will be created internally.
          If both baseDocReader and baseDocSysID are null, a DiffException is thrown.
        docToMergeWithSysID - The system ID of the document to merge with.
          Can be null, but only in case of docToMergeWithReader provided.
        docToMergeWithReader - The Reader for the document to merge with.
          If null and docToMergeWithSysID provided, the reader will be created internally.
          If both docToMergeWithReader and docToMergeWithSysID are null, a DiffException is thrown.
        diffOptions - The DiffOptions used to decide which comparing algorithm and which comparing options to use.
          Can be null in which case the comparison algorithm is chosen automatically and the default comparison options are used.
        Returns:
        A Reader for the contents of the resulted document with change tracking which can be used to review the differences and merge the two documents provided for comparison.
        Throws:
        DiffException - If something went wrong while generating the resulting document.

      • setNameOfAuthorOfChangeTrackingMarkers

        void setNameOfAuthorOfChangeTrackingMarkers​(java.lang.String authorName)
        Sets the name of the author of the change tracking markers created in the merged document. This name will be post-fixed with the " [Auto Merger]" construct, in order to make a clear association between the author and an imposed/fixed color used for highlighting track changes when loading the merged document in Oxygen.
        Parameters:
        authorName - The name of the author of the change tracking markers created in the merged document. Can be null, in which case the default name "Auto Merger" is used.