com.topologi.diffx.sequence.SequenceSlicer Maven / Gradle / Ivy
Show all versions of docx4j-diffx Show documentation
/*
* This file is part of the DiffX library.
*
* For licensing information please see the file license.txt included in the release.
* A copy of this licence can also be found at
* http://www.opensource.org/licenses/artistic-license-2.0.php
*/
package com.topologi.diffx.sequence;
import java.io.IOException;
import java.util.Iterator;
import com.topologi.diffx.event.CloseElementEvent;
import com.topologi.diffx.event.DiffXEvent;
import com.topologi.diffx.event.OpenElementEvent;
import com.topologi.diffx.format.DiffXFormatter;
/**
* The slicer takes two sequences and removes the common elements from the beginning
* and the end of the chain so that only the smallest sequences are passed to the
* DiffXAlgorithmBase.
*
* The slice does modify the original sequences.
*
*
Note: Using this class may lead to problems in the execution of the Diff-X
* algorithm and incorrect results, because it could potentially take off some parts
* that helps the Diff-X algorithm ensuring that the XML is well-formed.
*
* @author Christophe Lauret
* @version 15 January 2007
*/
public final class SequenceSlicer {
// FIXME: symmetrical slicing.
// class attributes ---------------------------------------------------------------------------
/**
* The first sequence of events to test.
*/
final EventSequence sequence1;
/**
* The second sequence of events to test.
*/
final EventSequence sequence2;
/**
* The common start between the two sequences.
*/
EventSequence start;
/**
* The common end between the two sequences.
*/
EventSequence end;
// constructor --------------------------------------------------------------------------------
/**
* Creates a new sequence slicer.
*
* @param seq0 The first sequence to slice.
* @param seq1 The second sequence to slice.
*/
public SequenceSlicer(EventSequence seq0, EventSequence seq1) {
this.sequence1 = seq0;
this.sequence2 = seq1;
}
// methods ------------------------------------------------------------------------------------
/**
* Slices the start and end of both sequences.
*
*
Equivalent to successive calls to sliceStart() and
* sliceEnd().
*
* @throws IllegalStateException If the start buffer is not empty.
*/
public void slice() throws IllegalStateException {
sliceStart();
sliceEnd();
}
/**
* Slices the start of both sequences.
*
*
The common start sequence will be stored in the class until the next
* {@link #formatStart(DiffXFormatter)} is called.
*
* @return The number of common elements at the start of the sequences.
*
* @throws IllegalStateException If the start buffer is not empty.
*/
public int sliceStart() throws IllegalStateException {
if (this.start != null)
throw new IllegalStateException("The start buffer already contains a subsequence.");
this.start = new EventSequence();
int toBeRemoved = 0; // the number of events to be removed
int depth = 0; // the depth of the XML or number of open elements
Iterator i = this.sequence1.eventIterator();
Iterator j = this.sequence2.eventIterator();
int counter = 0;
// calculate the max possible index for slicing.
while (i.hasNext() && j.hasNext()) {
DiffXEvent e = i.next();
if (j.next().equals(e)) {
counter++;
// increase the depth
if (e instanceof OpenElementEvent) {
depth++;
// decrease the depth
} else if (e instanceof CloseElementEvent) {
depth--;
}
// if depth = 1, it is a direct child of the document element,
// so we can cut off the whole branch
if (depth == 1 || depth == 0) {
toBeRemoved = counter;
}
} else {
break;
}
}
// slice the beginning of the file
for (int k = 0; k < toBeRemoved; k++) {
DiffXEvent e = this.sequence1.removeEvent(0);
this.sequence2.removeEvent(0);
this.start.addEvent(e);
}
return toBeRemoved;
}
/**
* Slices the end of both sequences.
*
* The common end sequence will be stored in the class until the next
* {@link #formatEnd(DiffXFormatter)} is called.
*
* @return The number of common elements at the end of the sequences.
*
* @throws IllegalStateException If the end buffer is not empty.
*/
public int sliceEnd() throws IllegalStateException {
if (this.end != null)
throw new IllegalStateException("The end buffer already contains a subsequence.");
this.end = new EventSequence();
int depth = 0; // the depth of the XML or number of open elements
int toBeRemoved = 0; // number of events to be removed from the end
int counter = 0; // number of events evaluated
int pos1 = this.sequence1.size() - 1; // current position of the first sequence
int pos2 = this.sequence2.size() - 1; // current position of the second sequence
while (pos1 >= 0 && pos2 >= 0) {
DiffXEvent e1 = this.sequence1.getEvent(pos1);
if (e1.equals(this.sequence2.getEvent(pos2))) {
counter++;
// increase the depth for close, decrease for open
if (e1 instanceof CloseElementEvent) {
depth++;
} else if (e1 instanceof OpenElementEvent) {
depth--;
}
// if depth = 1, it is a direct child of the document element,
// so we can cut off the whole branch
if (depth == 1 || depth == 0) {
toBeRemoved = counter;
}
pos1--; pos2--;
} else {
break;
}
}
// slice the end of the first sequence
int downTo = this.sequence1.size() - toBeRemoved;
for (int k = this.sequence1.size() - 1; k >= downTo; k--) {
DiffXEvent e = this.sequence1.removeEvent(k);
this.end.addEvent(0, e);
}
// slice the end of the second sequence
downTo = this.sequence2.size() - toBeRemoved;
for (int k = this.sequence2.size() - 1; k >= downTo; k--) {
this.sequence2.removeEvent(k);
}
return toBeRemoved;
}
/**
* Formats the start subsequence that has been buffered by this class.
*
*
This method will clear the buffer, but will do nothing if the start buffer is
* null.
*
* @param formatter The formatter that will handle the output.
*
* @throws NullPointerException If the specified formatter is null.
* @throws IOException If an error occurs whilst writing with the formatter.
*/
public void formatStart(DiffXFormatter formatter) throws NullPointerException, IOException {
if (this.start == null) return;
for (int i = 0; i < this.start.size(); i++) {
formatter.format(this.start.getEvent(i));
}
this.start = null;
}
/**
* Formats the end subsequence that has been buffered by this class.
*
*
This method will clear the buffer, but will do nothing if the end buffer is
* null.
*
* @param formatter The formatter that will handle the output.
*
* @throws NullPointerException If the specified formatter is null.
* @throws IOException If an error occurs whilst writing with the formatter.
*/
public void formatEnd(DiffXFormatter formatter) throws NullPointerException, IOException {
if (this.end == null) return;
for (int i = 0; i < this.end.size(); i++) {
formatter.format(this.end.getEvent(i));
}
this.end = null;
}
/**
* Returns the current start sequence buffer.
*
* @return The current start sequence buffer or null if none.
*/
public EventSequence getStart() {
return this.start;
}
/**
* Returns the current end sequence buffer.
*
* @return The current end sequence buffer or null if none.
*/
public EventSequence getEnd() {
return this.end;
}
}