org.xwiki.gwt.wysiwyg.client.diff
Class Diff

java.lang.Object
  org.xwiki.gwt.wysiwyg.client.diff.ToString
      org.xwiki.gwt.wysiwyg.client.diff.Diff

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class Diff
extends ToString

Implements a differencing engine that works on arrays of Object.

Within this library, the word text means a unit of information subject to version control.

Text is represented as Object[] because the diff engine is capable of handling more than plain ascci. In fact, arrays of any type that implements hashCode() and equals() correctly can be subject to differencing using this library.

This library provides a framework in which different differencing algorithms may be used. If no algorithm is specififed, a default algorithm is used.

Version:

$Revision: 1.1 $ $Date: 2006/03/12 00:24:21 $

Author:

Juanco Anez

See Also:

Delta, modifications: 27 Apr 2003 bwm Added some comments whilst trying to figure out the algorithm 03 May 2003 bwm Factored out the algorithm implementation into a separate difference algorithm class to allow pluggable algorithms.

Field Summary

protected DiffAlgorithm	algorithm The differencing algorithm to use.
static java.lang.String	NL The standard line separator.
protected java.lang.Object[]	orig The original sequence.
static java.lang.String	RCS_EOL The line separator to use in RCS format output.

Constructor Summary

Diff()
Create a differencing object for an empty text, using the default algorithm.

Diff(java.lang.Object[] original)
Create a differencing object using the default algorithm

Diff(java.lang.Object[] original, DiffAlgorithm algorithm)
Create a differencing object using the given algorithm

Method Summary

static boolean	compare(java.lang.Object[] orig, java.lang.Object[] rev) Compares the two input sequences.
protected DiffAlgorithm	defaultAlgorithm()
Revision	diff(java.lang.Object[] rev) compute the difference between the original and a revision.
static Revision	diff(java.lang.Object[] orig, java.lang.Object[] rev) compute the difference between an original and a revision.
static Revision	diff(java.lang.Object[] orig, java.lang.Object[] rev, DiffAlgorithm algorithm) compute the difference between an original and a revision.
static java.lang.Object[]	editAll(java.lang.Object[] text) Edits all of the items in the input sequence.
static java.lang.Object[]	randomEdit(java.lang.Object[] text) Performs random edits on the input sequence.
static java.lang.Object[]	randomEdit(java.lang.Object[] text, long seed) Performs random edits on the input sequence.
static java.lang.Object[]	shuffle(java.lang.Object[] text) Shuffles around the items in the input sequence.
static java.lang.Object[]	shuffle(java.lang.Object[] text, long seed) Shuffles around the items in the input sequence.

Methods inherited from class org.xwiki.gwt.wysiwyg.client.diff.ToString

arrayToString, stringToArray, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

NL

public static final java.lang.String NL

The standard line separator.

See Also:

Constant Field Values

RCS_EOL

public static final java.lang.String RCS_EOL

The line separator to use in RCS format output.

See Also:

Constant Field Values

orig

protected java.lang.Object[] orig

The original sequence.

algorithm

protected DiffAlgorithm algorithm

The differencing algorithm to use.

Constructor Detail

Diff

public Diff()

Create a differencing object for an empty text, using the default algorithm. This has been added to stop GWT's complains about not having a default constructor. You should use the other two constructors instead.

Diff

public Diff(java.lang.Object[] original)

Create a differencing object using the default algorithm

Parameters:

original - original text that will be compared

Diff

public Diff(java.lang.Object[] original,
            DiffAlgorithm algorithm)

Create a differencing object using the given algorithm

Parameters:

original - the original text which will be compared against

algorithm - the difference algorithm to use.

Method Detail

defaultAlgorithm

protected DiffAlgorithm defaultAlgorithm()

diff

public static Revision diff(java.lang.Object[] orig,
                            java.lang.Object[] rev)
                     throws DifferentiationFailedException

compute the difference between an original and a revision.

Parameters:

orig - the original

rev - the revision to compare with the original.

Returns:

a Revision describing the differences

Throws:

DifferentiationFailedException

diff

public static Revision diff(java.lang.Object[] orig,
                            java.lang.Object[] rev,
                            DiffAlgorithm algorithm)
                     throws DifferentiationFailedException

compute the difference between an original and a revision.

Parameters:

orig - the original

rev - the revision to compare with the original.

algorithm - the difference algorithm to use

Returns:

a Revision describing the differences

Throws:

DifferentiationFailedException

diff

public Revision diff(java.lang.Object[] rev)
              throws DifferentiationFailedException

compute the difference between the original and a revision.

Parameters:

rev - the revision to compare with the original.

Returns:

a Revision describing the differences

Throws:

DifferentiationFailedException

compare

public static boolean compare(java.lang.Object[] orig,
                              java.lang.Object[] rev)

Compares the two input sequences.

Parameters:

orig - The original sequence.

rev - The revised sequence.

Returns:

true if the sequences are identical. False otherwise.

editAll

public static java.lang.Object[] editAll(java.lang.Object[] text)

Edits all of the items in the input sequence.

Parameters:

text - The input sequence.

Returns:

A sequence of the same length with all the lines differing from the corresponding ones in the input.

randomEdit

public static java.lang.Object[] randomEdit(java.lang.Object[] text)

Performs random edits on the input sequence. Useful for testing.

Parameters:

text - The input sequence.

Returns:

The sequence with random edits performed.

randomEdit

public static java.lang.Object[] randomEdit(java.lang.Object[] text,
                                            long seed)

Performs random edits on the input sequence. Useful for testing.

Parameters:

text - The input sequence.

seed - A seed value for the randomizer.

Returns:

The sequence with random edits performed.

shuffle

public static java.lang.Object[] shuffle(java.lang.Object[] text)

Shuffles around the items in the input sequence.

Parameters:

text - The input sequence.

Returns:

The shuffled sequence.

shuffle

public static java.lang.Object[] shuffle(java.lang.Object[] text,
                                         long seed)

Shuffles around the items in the input sequence.

Parameters:

text - The input sequence.

seed - A seed value for randomizing the suffle.

Returns:

The shuffled sequence.