com.aspose.words

Class Comparer

java.lang.Object

com.aspose.words.Processor

com.aspose.words.Comparer

public class Comparer
extends Processor

Provides methods intended to compare documents.

Field Summary

Fields inherited from class com.aspose.words.Processor

mResultDocument

Method Summary

Modifier and Type	Method and Description
protected void	checkArgumentsSet()
static void	compare(java.io.InputStream v1, java.io.InputStream v2, java.io.OutputStream outputStream, int saveFormat, java.lang.String author, java.util.Date dateTime)
static void	compare(java.io.InputStream v1, java.io.InputStream v2, java.io.OutputStream outputStream, int saveFormat, java.lang.String author, java.util.Date dateTime, CompareOptions compareOptions)
static void	compare(java.io.InputStream v1, java.io.InputStream v2, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.String author, java.util.Date dateTime)
static void	compare(java.io.InputStream v1, java.io.InputStream v2, java.io.OutputStream outputStream, SaveOptions saveOptions, java.lang.String author, java.util.Date dateTime, CompareOptions compareOptions)
static void	compare(java.lang.String v1, java.lang.String v2, java.lang.String outputFileName, int saveFormat, java.lang.String author, java.util.Date dateTime)
static void	compare(java.lang.String v1, java.lang.String v2, java.lang.String outputFileName, int saveFormat, java.lang.String author, java.util.Date dateTime, CompareOptions compareOptions)
static void	compare(java.lang.String v1, java.lang.String v2, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.String author, java.util.Date dateTime)
static void	compare(java.lang.String v1, java.lang.String v2, java.lang.String outputFileName, SaveOptions saveOptions, java.lang.String author, java.util.Date dateTime, CompareOptions compareOptions) Compares two documents with additional options and saves the differences to the specified output file in the provided save format, producing changes as a number of edit and format revisions.
static void	compare(java.lang.String v1, java.lang.String v2, java.lang.String outputFileName, java.lang.String author, java.util.Date dateTime)
static void	compare(java.lang.String v1, java.lang.String v2, java.lang.String outputFileName, java.lang.String author, java.util.Date dateTime, CompareOptions compareOptions) Compares two documents with additional options and saves the differences to the specified output file, producing changes as a number of edit and format revisions.
static java.io.OutputStream[]	compareToImages(java.io.InputStream v1, java.io.InputStream v2, ImageSaveOptions imageSaveOptions, java.lang.String author, java.util.Date dateTime)
static java.io.OutputStream[]	compareToImages(java.io.InputStream v1, java.io.InputStream v2, ImageSaveOptions imageSaveOptions, java.lang.String author, java.util.Date dateTime, CompareOptions compareOptions) Compares two documents and saves the differences as images.
static java.io.OutputStream[]	compareToImages(java.lang.String v1, java.lang.String v2, ImageSaveOptions imageSaveOptions, java.lang.String author, java.util.Date dateTime)
static java.io.OutputStream[]	compareToImages(java.lang.String v1, java.lang.String v2, ImageSaveOptions imageSaveOptions, java.lang.String author, java.util.Date dateTime, CompareOptions compareOptions) Compares two documents and saves the differences as images.
static Comparer	create() Creates new instance of the converter processor.
static Comparer	create(ComparerContext context) Creates new instance of the comparer processor.
protected void	executeCore()

Methods inherited from class com.aspose.words.Processor

execute, from, from, from, from, getPartFileName, to, to, to, to, to, to, to, toOutput, toOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Comparer create()

Creates new instance of the converter processor.

create

public static Comparer create(ComparerContext context)

Creates new instance of the comparer processor.

Examples:

Shows how to simple compare documents using context.

 
 // There is a several ways to compare documents:
 String firstDoc = getMyDir() + "Table column bookmarks.docx";
 String secondDoc = getMyDir() + "Table column bookmarks.doc";

 ComparerContext comparerContext = new ComparerContext();
 comparerContext.getCompareOptions().setIgnoreCaseChanges(true);
 comparerContext.setAuthor("Author");
 comparerContext.setDateTime(new Date());

 Comparer.create(comparerContext)
         .from(firstDoc)
         .from(secondDoc)
         .to(getArtifactsDir() + "LowCode.CompareContextDocuments.docx")
         .execute();
 
 

Shows how to compare documents from the stream using context.

 
 // There is a several ways to compare documents from the stream:
 try (FileInputStream firstStreamIn = new FileInputStream(getMyDir() + "Table column bookmarks.docx")) {
     try (FileInputStream secondStreamIn = new FileInputStream(getMyDir() + "Table column bookmarks.doc")) {
         ComparerContext comparerContext = new ComparerContext();
         comparerContext.getCompareOptions().setIgnoreCaseChanges(true);
         comparerContext.setAuthor("Author");
         comparerContext.setDateTime(new Date());

         try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.CompareContextStreamDocuments.docx")) {
             Comparer.create(comparerContext)
                     .from(firstStreamIn)
                     .from(secondStreamIn)
                     .to(streamOut, SaveFormat.DOCX)
                     .execute();
         }
     }
 }
 
 

executeCore

protected void executeCore()
                    throws java.lang.Exception

Overrides:

executeCore in class Processor

Throws:

java.lang.Exception

checkArgumentsSet

protected void checkArgumentsSet()

Overrides:

checkArgumentsSet in class Processor

compare

public static void compare(java.lang.String v1,
                           java.lang.String v2,
                           java.lang.String outputFileName,
                           java.lang.String author,
                           java.util.Date dateTime)
                    throws java.lang.Exception

Throws:

java.lang.Exception

compare

public static void compare(java.lang.String v1,
                           java.lang.String v2,
                           java.lang.String outputFileName,
                           java.lang.String author,
                           java.util.Date dateTime,
                           CompareOptions compareOptions)
                    throws java.lang.Exception

Compares two documents with additional options and saves the differences to the specified output file, producing changes as a number of edit and format revisions.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Examples:

Shows how to simple compare documents.

 
 // There is a several ways to compare documents:
 String firstDoc = getMyDir() + "Table column bookmarks.docx";
 String secondDoc = getMyDir() + "Table column bookmarks.doc";

 Comparer.compare(firstDoc, secondDoc, getArtifactsDir() + "LowCode.CompareDocuments.1.docx", "Author", new Date());
 Comparer.compare(firstDoc, secondDoc, getArtifactsDir() + "LowCode.CompareDocuments.2.docx", SaveFormat.DOCX, "Author", new Date());
 CompareOptions options = new CompareOptions();
 options.setIgnoreCaseChanges(true);
 Comparer.compare(firstDoc, secondDoc, getArtifactsDir() + "LowCode.CompareDocuments.3.docx", "Author", new Date(), options);
 Comparer.compare(firstDoc, secondDoc, getArtifactsDir() + "LowCode.CompareDocuments.4.docx", SaveFormat.DOCX, "Author", new Date(), options);
 
 

Parameters:

v1 - The original document.

v2 - The modified document.

outputFileName - The output file name.

author - Initials of the author to use for revisions.

dateTime - The date and time to use for revisions.

compareOptions - Document comparison options.

Throws:

java.lang.Exception

compare

public static void compare(java.lang.String v1,
                           java.lang.String v2,
                           java.lang.String outputFileName,
                           int saveFormat,
                           java.lang.String author,
                           java.util.Date dateTime)
                    throws java.lang.Exception

Throws:

java.lang.Exception

compare

public static void compare(java.lang.String v1,
                           java.lang.String v2,
                           java.lang.String outputFileName,
                           int saveFormat,
                           java.lang.String author,
                           java.util.Date dateTime,
                           CompareOptions compareOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

compare

public static void compare(java.lang.String v1,
                           java.lang.String v2,
                           java.lang.String outputFileName,
                           SaveOptions saveOptions,
                           java.lang.String author,
                           java.util.Date dateTime)
                    throws java.lang.Exception

Throws:

java.lang.Exception

compare

public static void compare(java.lang.String v1,
                           java.lang.String v2,
                           java.lang.String outputFileName,
                           SaveOptions saveOptions,
                           java.lang.String author,
                           java.util.Date dateTime,
                           CompareOptions compareOptions)
                    throws java.lang.Exception

Compares two documents with additional options and saves the differences to the specified output file in the provided save format, producing changes as a number of edit and format revisions.

Remarks:

If the output format is an image (BMP, EMF, EPS, GIF, JPEG, PNG, or WebP), each page of the output will be saved as a separate file. The specified output file name will be used to generate file names for each part following the rule: outputFile_partIndex.extension.

If the output format is TIFF, the output will be saved as a single multi-frame TIFF file.

Parameters:

v1 - The original document.

v2 - The modified document.

outputFileName - The output file name.

saveOptions - The output's save options.

author - Initials of the author to use for revisions.

dateTime - The date and time to use for revisions.

compareOptions - Document comparison options.

Throws:

java.lang.Exception

compare

public static void compare(java.io.InputStream v1,
                           java.io.InputStream v2,
                           java.io.OutputStream outputStream,
                           int saveFormat,
                           java.lang.String author,
                           java.util.Date dateTime)
                    throws java.lang.Exception

Throws:

java.lang.Exception

compare

public static void compare(java.io.InputStream v1,
                           java.io.InputStream v2,
                           java.io.OutputStream outputStream,
                           int saveFormat,
                           java.lang.String author,
                           java.util.Date dateTime,
                           CompareOptions compareOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

compare

public static void compare(java.io.InputStream v1,
                           java.io.InputStream v2,
                           java.io.OutputStream outputStream,
                           SaveOptions saveOptions,
                           java.lang.String author,
                           java.util.Date dateTime)
                    throws java.lang.Exception

Throws:

java.lang.Exception

compare

public static void compare(java.io.InputStream v1,
                           java.io.InputStream v2,
                           java.io.OutputStream outputStream,
                           SaveOptions saveOptions,
                           java.lang.String author,
                           java.util.Date dateTime,
                           CompareOptions compareOptions)
                    throws java.lang.Exception

Throws:

java.lang.Exception

compareToImages

public static java.io.OutputStream[] compareToImages(java.lang.String v1,
                                                     java.lang.String v2,
                                                     ImageSaveOptions imageSaveOptions,
                                                     java.lang.String author,
                                                     java.util.Date dateTime)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

compareToImages

public static java.io.OutputStream[] compareToImages(java.lang.String v1,
                                                     java.lang.String v2,
                                                     ImageSaveOptions imageSaveOptions,
                                                     java.lang.String author,
                                                     java.util.Date dateTime,
                                                     CompareOptions compareOptions)
                                              throws java.lang.Exception

Compares two documents and saves the differences as images. Each item in the returned array represents a single page of the output rendered as an image.

Parameters:

v1 - The original document.

v2 - The modified document.

imageSaveOptions - The output's image save options.

author - Initials of the author to use for revisions.

dateTime - The date and time to use for revisions.

compareOptions - Document comparison options.

Throws:

java.lang.Exception

compareToImages

public static java.io.OutputStream[] compareToImages(java.io.InputStream v1,
                                                     java.io.InputStream v2,
                                                     ImageSaveOptions imageSaveOptions,
                                                     java.lang.String author,
                                                     java.util.Date dateTime)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

compareToImages

public static java.io.OutputStream[] compareToImages(java.io.InputStream v1,
                                                     java.io.InputStream v2,
                                                     ImageSaveOptions imageSaveOptions,
                                                     java.lang.String author,
                                                     java.util.Date dateTime,
                                                     CompareOptions compareOptions)
                                              throws java.lang.Exception

Compares two documents and saves the differences as images. Each item in the returned array represents a single page of the output rendered as an image.

Examples:

Shows how to compare documents and save results as images.

 
 // There is a several ways to compare documents:
 String firstDoc = getMyDir() + "Table column bookmarks.docx";
 String secondDoc = getMyDir() + "Table column bookmarks.doc";

 OutputStream[] pages = Comparer.compareToImages(firstDoc, secondDoc, new ImageSaveOptions(SaveFormat.PNG), "Author", new Date());

 try (FileInputStream firstStreamIn = new FileInputStream(firstDoc)) {
     try (FileInputStream secondStreamIn = new FileInputStream(secondDoc)) {
         CompareOptions compareOptions = new CompareOptions();
         compareOptions.setIgnoreCaseChanges(true);
         pages = Comparer.compareToImages(firstStreamIn, secondStreamIn, new ImageSaveOptions(SaveFormat.PNG), "Author", new Date(), compareOptions);
     }
 }
 
 

Parameters:

v1 - The original document.

v2 - The modified document.

imageSaveOptions - The output's image save options.

author - Initials of the author to use for revisions.

dateTime - The date and time to use for revisions.

compareOptions - Document comparison options.

Throws:

java.lang.Exception