Index: branches/autoquest-core-tasktrees-alignment/.settings/org.eclipse.jdt.ui.prefs =================================================================== --- branches/autoquest-core-tasktrees-alignment/.settings/org.eclipse.jdt.ui.prefs (revision 1733) +++ branches/autoquest-core-tasktrees-alignment/.settings/org.eclipse.jdt.ui.prefs (revision 1733) @@ -0,0 +1,60 @@ +cleanup.add_default_serial_version_id=true +cleanup.add_generated_serial_version_id=false +cleanup.add_missing_annotations=true +cleanup.add_missing_deprecated_annotations=true +cleanup.add_missing_methods=false +cleanup.add_missing_nls_tags=false +cleanup.add_missing_override_annotations=true +cleanup.add_missing_override_annotations_interface_methods=true +cleanup.add_serial_version_id=false +cleanup.always_use_blocks=true +cleanup.always_use_parentheses_in_expressions=true +cleanup.always_use_this_for_non_static_field_access=false +cleanup.always_use_this_for_non_static_method_access=false +cleanup.convert_functional_interfaces=false +cleanup.convert_to_enhanced_for_loop=false +cleanup.correct_indentation=true +cleanup.format_source_code=true +cleanup.format_source_code_changes_only=false +cleanup.insert_inferred_type_arguments=false +cleanup.make_local_variable_final=true +cleanup.make_parameters_final=false +cleanup.make_private_fields_final=true +cleanup.make_type_abstract_if_missing_method=false +cleanup.make_variable_declarations_final=true +cleanup.never_use_blocks=false +cleanup.never_use_parentheses_in_expressions=false +cleanup.organize_imports=false +cleanup.qualify_static_field_accesses_with_declaring_class=false +cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=true +cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=true +cleanup.qualify_static_member_accesses_with_declaring_class=true +cleanup.qualify_static_method_accesses_with_declaring_class=false +cleanup.remove_private_constructors=true +cleanup.remove_redundant_type_arguments=true +cleanup.remove_trailing_whitespaces=false +cleanup.remove_trailing_whitespaces_all=true +cleanup.remove_trailing_whitespaces_ignore_empty=false +cleanup.remove_unnecessary_casts=true +cleanup.remove_unnecessary_nls_tags=true +cleanup.remove_unused_imports=true +cleanup.remove_unused_local_variables=false +cleanup.remove_unused_private_fields=true +cleanup.remove_unused_private_members=false +cleanup.remove_unused_private_methods=true +cleanup.remove_unused_private_types=true +cleanup.sort_members=true +cleanup.sort_members_all=false +cleanup.use_anonymous_class_creation=false +cleanup.use_blocks=true +cleanup.use_blocks_only_for_return_and_throw=false +cleanup.use_lambda=true +cleanup.use_parentheses_in_expressions=true +cleanup.use_this_for_non_static_field_access=false +cleanup.use_this_for_non_static_field_access_only_if_necessary=true +cleanup.use_this_for_non_static_method_access=false +cleanup.use_this_for_non_static_method_access_only_if_necessary=true +cleanup.use_type_arguments=false +cleanup_profile=_ralph +cleanup_settings_version=2 +eclipse.preferences.version=1 Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/Alignment.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/Alignment.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/Alignment.java (revision 1733) @@ -5,5 +5,4 @@ public class Alignment { ArrayList alingment; - - + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/AlignmentAlgorithm.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/AlignmentAlgorithm.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/AlignmentAlgorithm.java (revision 1733) @@ -6,5 +6,10 @@ public interface AlignmentAlgorithm { - + + void align(NumberSequence input1, NumberSequence input2, + SubstitutionMatrix submat, float threshold); + + public abstract ArrayList getAlignment(); + /** * Get the alignment score between the two input strings. @@ -12,16 +17,11 @@ public abstract double getAlignmentScore(); - public abstract ArrayList getAlignment(); + public abstract ArrayList getMatches(); + + public double getMaxScore(); + + public abstract void printAlignment(); public abstract void printDPMatrix(); - public abstract void printAlignment(); - - public abstract ArrayList getMatches(); - - public double getMaxScore(); - - void align(NumberSequence input1, NumberSequence input2, - SubstitutionMatrix submat, float threshold); - } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/AlignmentAlgorithmFactory.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/AlignmentAlgorithmFactory.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/AlignmentAlgorithmFactory.java (revision 1733) @@ -1,27 +1,26 @@ package de.ugoe.cs.autoquest.tasktrees.alignment.algorithms; +public class AlignmentAlgorithmFactory { -public class AlignmentAlgorithmFactory { - - public static void setDefaultAlgorithm(String algorithmname) { - //TODO: check for valid algorihm class names here - algorithmclass = algorithmname; - } - - private static String algorithmclass = "de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.SmithWatermanRepeated"; - - - public static AlignmentAlgorithm create() { Class newclass; Object object = null; try { - newclass = Class.forName(algorithmclass); - object = newclass.newInstance(); - - } catch (ClassNotFoundException | SecurityException | InstantiationException | IllegalAccessException | IllegalArgumentException e) { + newclass = Class.forName(algorithmclass); + object = newclass.newInstance(); + + } catch (ClassNotFoundException | SecurityException + | InstantiationException | IllegalAccessException + | IllegalArgumentException e) { e.printStackTrace(); } return (AlignmentAlgorithm) object; } + + public static void setDefaultAlgorithm(String algorithmname) { + // TODO: check for valid algorihm class names here + algorithmclass = algorithmname; + } + + private static String algorithmclass = "de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.SmithWatermanRepeated"; } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/AlignmentHelpers.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/AlignmentHelpers.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/AlignmentHelpers.java (revision 1733) @@ -7,13 +7,27 @@ import de.ugoe.cs.autoquest.eventcore.guimodel.IGUIElement; +public class AlignmentHelpers extends GUIModel { -public class AlignmentHelpers extends GUIModel { - + public static int distanceBetween(IGUIElement first, IGUIElement second) { - - /** - * - */ - private static final long serialVersionUID = -2593092958275693133L; + int hopcount1 = 0; + int hopcount2 = 0; + final List tmp = new ArrayList(); + tmp.add(first); + tmp.add(second); + final IGUIElement commonDenominator = getCommonDenominator(tmp); + + while (!(first.equals(commonDenominator))) { + first = first.getParent(); + hopcount1++; + } + + while (!(second.equals(commonDenominator))) { + second = second.getParent(); + hopcount2++; + } + + return hopcount1 + hopcount2; + } /** @@ -24,9 +38,10 @@ *

*/ - private static IGUIElement getCommonDenominator(List guiElements) { + private static IGUIElement getCommonDenominator( + List guiElements) { IGUIElement commonDenominator = null; if (guiElements.size() > 0) { - List commonDenominatorPath = new ArrayList(); + final List commonDenominatorPath = new ArrayList(); // create a reference list using the first GUI element @@ -49,5 +64,5 @@ // well as it subsequent // siblings - List currentPath = new ArrayList(); + final List currentPath = new ArrayList(); for (int i = 1; i < guiElements.size(); i++) { currentPath.clear(); @@ -55,5 +70,5 @@ while (guiElement != null) { // if (guiElementMatchesConsideredTypes(guiElement)) { - currentPath.add(0, guiElement); + currentPath.add(0, guiElement); // } guiElement = guiElement.getParent(); @@ -84,25 +99,8 @@ } - public static int distanceBetween(IGUIElement first, IGUIElement second) { - - int hopcount1 = 0; - int hopcount2 = 0; - List tmp = new ArrayList(); - tmp.add(first); - tmp.add(second); - IGUIElement commonDenominator = getCommonDenominator(tmp); - - while(!(first.equals(commonDenominator))) { - first = first.getParent(); - hopcount1++; - } - - while(!(second.equals(commonDenominator))) { - second = second.getParent(); - hopcount2++; - } - - return hopcount1 + hopcount2; - } + /** + * + */ + private static final long serialVersionUID = -2593092958275693133L; } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/Constants.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/Constants.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/Constants.java (revision 1733) @@ -2,5 +2,5 @@ public class Constants { - + public static final int GAP_SYMBOL = -1; public static final int UNMATCHED_SYMBOL = -2; Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/Match.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/Match.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/Match.java (revision 1733) @@ -5,7 +5,5 @@ import java.util.LinkedList; - - -public class Match implements Serializable{ +public class Match implements Serializable { /** * @@ -13,5 +11,5 @@ private static final long serialVersionUID = -3206992723755714741L; - private ArrayList matchseqs; + private final ArrayList matchseqs; private LinkedList occurences; @@ -24,31 +22,10 @@ } - public NumberSequence getFirstSequence() { - return matchseqs.get(0); - } - - public NumberSequence getSecondSequence() { - return matchseqs.get(1); - } - - public void setFirstSequence(NumberSequence seq) { - matchseqs.set(0, seq); - } - - public void setSecondSequence(NumberSequence seq) { - matchseqs.set(1, seq); - } - public void addOccurence(MatchOccurence occurence) { occurences.add(occurence); } - public int occurenceCount() { - return occurences.size(); - } - - public int size() { - //Both sequences should be equally long - return matchseqs.get(0).size(); + public void addOccurencesOf(Match m) { + occurences.addAll(m.getOccurences()); } @@ -63,6 +40,22 @@ } + public NumberSequence getFirstSequence() { + return matchseqs.get(0); + } + public LinkedList getOccurences() { return occurences; + } + + public NumberSequence getSecondSequence() { + return matchseqs.get(1); + } + + public int occurenceCount() { + return occurences.size(); + } + + public void setFirstSequence(NumberSequence seq) { + matchseqs.set(0, seq); } @@ -71,11 +64,12 @@ } - - public void addOccurencesOf(Match m) { - occurences.addAll(m.getOccurences()); + public void setSecondSequence(NumberSequence seq) { + matchseqs.set(1, seq); } - - - + + public int size() { + // Both sequences should be equally long + return matchseqs.get(0).size(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/MatchOccurence.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/MatchOccurence.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/MatchOccurence.java (revision 1733) @@ -3,5 +3,5 @@ import java.io.Serializable; -public class MatchOccurence implements Serializable{ +public class MatchOccurence implements Serializable { /** * @@ -11,5 +11,5 @@ private int endindex; private int sequenceId; - + public MatchOccurence(int startindex, int endindex, int sequenceId) { this.startindex = startindex; @@ -17,7 +17,15 @@ this.sequenceId = sequenceId; } - + public int getEndindex() { return endindex; + } + + public int getSequenceId() { + return sequenceId; + } + + public int getStartindex() { + return startindex; } @@ -26,16 +34,10 @@ } - public int getStartindex() { - return startindex; + public void setSequenceId(int sequenceId) { + this.sequenceId = sequenceId; } + public void setStartindex(int startindex) { this.startindex = startindex; } - public int getSequenceId() { - return sequenceId; - } - - public void setSequenceId(int sequenceId) { - this.sequenceId = sequenceId; - } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/MatrixEntry.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/MatrixEntry.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/MatrixEntry.java (revision 1733) @@ -6,24 +6,19 @@ private int xvalue; private int yvalue; - - public MatrixEntry(float score, MatrixEntry previous) { + + public MatrixEntry() { + } + + public MatrixEntry(float score, MatrixEntry previous) { this.score = score; this.previous = previous; } - - public MatrixEntry() { + + public MatrixEntry getPrevious() { + return previous; } public double getScore() { return score; - } - public void setScore(double score) { - this.score = score; - } - public MatrixEntry getPrevious() { - return previous; - } - public void setPrevious(MatrixEntry previous) { - this.previous = previous; } @@ -32,10 +27,18 @@ } + public int getYvalue() { + return yvalue; + } + + public void setPrevious(MatrixEntry previous) { + this.previous = previous; + } + + public void setScore(double score) { + this.score = score; + } + public void setXvalue(int xvalue) { this.xvalue = xvalue; - } - - public int getYvalue() { - return yvalue; } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/NeedlemanWunsch.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/NeedlemanWunsch.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/NeedlemanWunsch.java (revision 1733) @@ -8,5 +8,4 @@ import de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.Constants; - public class NeedlemanWunsch implements AlignmentAlgorithm { @@ -39,4 +38,201 @@ private SubstitutionMatrix submat; + @Override + public void align(NumberSequence input1, NumberSequence input2, + SubstitutionMatrix submat, float threshold) { + this.input1 = input1.getSequence(); + this.input2 = input2.getSequence(); + length1 = input1.size(); + length2 = input2.size(); + this.submat = submat; + + // System.out.println("Starting SmithWaterman algorithm with a " + // + submat.getClass() + " Substitution Matrix: " + + // submat.getClass().getCanonicalName()); + + matrix = new MatrixEntry[length1 + 1][length2 + 1]; + alignment = new ArrayList(); + + for (int i = 0; i < (length1 + 1); i++) { + for (int j = 0; j < (length2 + 1); j++) { + matrix[i][j] = new MatrixEntry(); + } + } + + buildMatrix(); + traceback(); + + } + + /** + * Build the score matrix using dynamic programming. + */ + private void buildMatrix() { + if (submat.getGapPenalty() >= 0) { + throw new Error("Indel score must be negative"); + } + + // it's a gap + matrix[0][0].setScore(0); + matrix[0][0].setPrevious(null); // starting point + + // the first column + for (int j = 1; j <= length2; j++) { + matrix[0][j].setScore(j * submat.getGapPenalty()); + matrix[0][j].setPrevious(matrix[0][j - 1]); + matrix[0][j].setYvalue(input2[j - 1]); + matrix[0][j].setXvalue(Constants.GAP_SYMBOL); + } + // the first row + + for (int j = 1; j <= length1; j++) { + matrix[j][0].setScore(j * submat.getGapPenalty()); + matrix[j][0].setPrevious(matrix[j - 1][0]); + matrix[j][0].setXvalue(input1[j - 1]); + matrix[j][0].setYvalue(Constants.GAP_SYMBOL); + } + + for (int i = 1; i <= length1; i++) { + + for (int j = 1; j <= length2; j++) { + final double diagScore = matrix[i - 1][j - 1].getScore() + + similarity(i, j); + final double upScore = matrix[i][j - 1].getScore() + + submat.getGapPenalty(); + final double leftScore = matrix[i - 1][j].getScore() + + submat.getGapPenalty(); + + matrix[i][j].setScore(Math.max(diagScore, + Math.max(upScore, leftScore))); + + // find the directions that give the maximum scores. + // TODO: Multiple directions are ignored, we choose the first + // maximum score + // True if we had a match + if (diagScore == matrix[i][j].getScore()) { + matrix[i][j].setPrevious(matrix[i - 1][j - 1]); + matrix[i][j].setXvalue(input1[i - 1]); + matrix[i][j].setYvalue(input2[j - 1]); + } + // true if we took an event from sequence x and not from y + if (leftScore == matrix[i][j].getScore()) { + matrix[i][j].setXvalue(input1[i - 1]); + matrix[i][j].setYvalue(Constants.GAP_SYMBOL); + matrix[i][j].setPrevious(matrix[i - 1][j]); + } + // true if we took an event from sequence y and not from x + if (upScore == matrix[i][j].getScore()) { + matrix[i][j].setXvalue(Constants.GAP_SYMBOL); + matrix[i][j].setYvalue(input2[j - 1]); + matrix[i][j].setPrevious(matrix[i][j - 1]); + } + } + } + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm + * #getAlignment() + */ + @Override + public ArrayList getAlignment() { + return alignment; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm + * #getAlignmentScore() + */ + @Override + public double getAlignmentScore() { + return getMaxScore(); + } + + @Override + public ArrayList getMatches() { + // TODO Auto-generated method stub + return null; + } + + /** + * Get the maximum value in the score matrix. + */ + @Override + public double getMaxScore() { + double maxScore = 0; + + // skip the first row and column + for (int i = 1; i <= length1; i++) { + for (int j = 1; j <= length2; j++) { + if (matrix[i][j].getScore() > maxScore) { + maxScore = matrix[i][j].getScore(); + } + } + } + + return maxScore; + } + + @Override + public void printAlignment() { + final int[] tmp1 = alignment.get(0).getSequence(); + final int[] tmp2 = alignment.get(1).getSequence(); + for (int i = 0; i < tmp1.length; i++) { + if (tmp1[i] == Constants.GAP_SYMBOL) { + System.out.print(" ___"); + } else if (tmp1[i] == Constants.UNMATCHED_SYMBOL) { + System.out.print(" ..."); + } else { + System.out.format("%5d", tmp1[i]); + } + + } + System.out.println(); + for (int i = 0; i < tmp2.length; i++) { + if (tmp2[i] == Constants.GAP_SYMBOL) { + System.out.print(" ___"); + } else if (tmp2[i] == Constants.UNMATCHED_SYMBOL) { + System.out.print(" ..."); + } else { + System.out.format("%5d", tmp2[i]); + } + + } + System.out.println(); + + } + + /** + * print the dynmaic programming matrix + */ + @Override + public void printDPMatrix() { + System.out.print(" "); + for (int i = 1; i <= length1; i++) { + System.out.format("%5d", input1[i - 1]); + } + System.out.println(); + for (int j = 0; j <= length2; j++) { + if (j > 0) { + System.out.format("%5d ", input2[j - 1]); + } else { + System.out.print(" "); + } + for (int i = 0; i <= length1; i++) { + System.out.format("%4.1f ", matrix[i][j].getScore()); + } + System.out.println(); + } + } + + public void setAlignment(ArrayList alignment) { + this.alignment = alignment; + } /** @@ -54,130 +250,34 @@ } - /** - * Build the score matrix using dynamic programming. - */ - private void buildMatrix() { - if (submat.getGapPenalty() >= 0) { - throw new Error("Indel score must be negative"); - } - - // it's a gap - matrix[0][0].setScore(0); - matrix[0][0].setPrevious(null); // starting point - - // the first column - for (int j = 1; j <= length2; j++) { - matrix[0][j].setScore(j*submat.getGapPenalty()); - matrix[0][j].setPrevious(matrix[0][j - 1]); - matrix[0][j].setYvalue(input2[j-1]); - matrix[0][j].setXvalue(Constants.GAP_SYMBOL); - } - // the first row - - for (int j = 1; j <= length1; j++) { - matrix[j][0].setScore(j*submat.getGapPenalty()); - matrix[j][0].setPrevious(matrix[j - 1][0]); - matrix[j][0].setXvalue(input1[j-1]); - matrix[j][0].setYvalue(Constants.GAP_SYMBOL); - } - - for (int i = 1; i <= length1; i++) { - - for (int j = 1; j <= length2; j++) { - double diagScore = matrix[i - 1][j - 1].getScore() - + similarity(i, j); - double upScore = matrix[i][j - 1].getScore() - + submat.getGapPenalty(); - double leftScore = matrix[i - 1][j].getScore() - + submat.getGapPenalty(); - - matrix[i][j].setScore(Math.max(diagScore, - Math.max(upScore, leftScore))); - - // find the directions that give the maximum scores. - // TODO: Multiple directions are ignored, we choose the first - // maximum score - // True if we had a match - if (diagScore == matrix[i][j].getScore()) { - matrix[i][j].setPrevious(matrix[i - 1][j - 1]); - matrix[i][j].setXvalue(input1[i - 1]); - matrix[i][j].setYvalue(input2[j - 1]); - } - // true if we took an event from sequence x and not from y - if (leftScore == matrix[i][j].getScore()) { - matrix[i][j].setXvalue(input1[i - 1]); - matrix[i][j].setYvalue(Constants.GAP_SYMBOL); - matrix[i][j].setPrevious(matrix[i - 1][j]); - } - // true if we took an event from sequence y and not from x - if (upScore == matrix[i][j].getScore()) { - matrix[i][j].setXvalue(Constants.GAP_SYMBOL); - matrix[i][j].setYvalue(input2[j - 1]); - matrix[i][j].setPrevious(matrix[i][j - 1]); - } - } - } - } - - /** - * Get the maximum value in the score matrix. - */ - public double getMaxScore() { - double maxScore = 0; - - // skip the first row and column - for (int i = 1; i <= length1; i++) { - for (int j = 1; j <= length2; j++) { - if (matrix[i][j].getScore() > maxScore) { - maxScore = matrix[i][j].getScore(); - } - } - } - - return maxScore; - } - - /* - * (non-Javadoc) - * - * @see - * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm - * #getAlignmentScore() - */ - @Override - public double getAlignmentScore() { - return getMaxScore(); - } - public void traceback() { MatrixEntry tmp = matrix[length1][length2]; - LinkedList aligned1 = new LinkedList(); - LinkedList aligned2 = new LinkedList(); + final LinkedList aligned1 = new LinkedList(); + final LinkedList aligned2 = new LinkedList(); while (tmp.getPrevious() != null) { - + aligned1.add(new Integer(tmp.getXvalue())); aligned2.add(new Integer(tmp.getYvalue())); tmp = tmp.getPrevious(); - } - + } + // reverse order of the alignment - int reversed1[] = new int[aligned1.size()]; - int reversed2[] = new int[aligned2.size()]; + final int reversed1[] = new int[aligned1.size()]; + final int reversed2[] = new int[aligned2.size()]; int count = 0; - for (Iterator it = aligned1.iterator(); it.hasNext();) { + for (final Iterator it = aligned1.iterator(); it.hasNext();) { count++; reversed1[reversed1.length - count] = it.next(); - + } count = 0; - for (Iterator it = aligned2.iterator(); it.hasNext();) { + for (final Iterator it = aligned2.iterator(); it.hasNext();) { count++; reversed2[reversed2.length - count] = it.next(); } - NumberSequence ns1 = new NumberSequence(reversed1.length); - NumberSequence ns2 = new NumberSequence(reversed2.length); + final NumberSequence ns1 = new NumberSequence(reversed1.length); + final NumberSequence ns2 = new NumberSequence(reversed2.length); ns1.setSequence(reversed1); ns2.setSequence(reversed2); @@ -187,110 +287,3 @@ } - - /** - * print the dynmaic programming matrix - */ - public void printDPMatrix() { - System.out.print(" "); - for (int i = 1; i <= length1; i++) - System.out.format("%5d", input1[i - 1]); - System.out.println(); - for (int j = 0; j <= length2; j++) { - if (j > 0) - System.out.format("%5d ", input2[j - 1]); - else { - System.out.print(" "); - } - for (int i = 0; i <= length1; i++) { - System.out.format("%4.1f ", matrix[i][j].getScore()); - } - System.out.println(); - } - } - - public void printAlignment() { - int[] tmp1 = alignment.get(0).getSequence(); - int[] tmp2 = alignment.get(1).getSequence(); - for (int i=0; i< tmp1.length;i++) { - if(tmp1[i] == Constants.GAP_SYMBOL) { - System.out.print(" ___"); - } - else if(tmp1[i] == Constants.UNMATCHED_SYMBOL) { - System.out.print(" ..."); - } - else { - System.out.format("%5d", tmp1[i]); - } - - } - System.out.println(); - for (int i=0; i< tmp2.length;i++) { - if(tmp2[i] == Constants.GAP_SYMBOL) { - System.out.print(" ___"); - } - else if(tmp2[i] == Constants.UNMATCHED_SYMBOL) { - System.out.print(" ..."); - } - else { - System.out.format("%5d", tmp2[i]); - } - - } - System.out.println(); - - - - } - - /* - * (non-Javadoc) - * - * @see - * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm - * #getAlignment() - */ - @Override - public ArrayList getAlignment() { - return alignment; - } - - public void setAlignment(ArrayList alignment) { - this.alignment = alignment; - } - - @Override - public ArrayList getMatches() { - // TODO Auto-generated method stub - return null; - } - - @Override - public void align(NumberSequence input1, NumberSequence input2, SubstitutionMatrix submat, - float threshold) { - this.input1 = input1.getSequence(); - this.input2 = input2.getSequence(); - length1 = input1.size(); - length2 = input2.size(); - this.submat = submat; - - // System.out.println("Starting SmithWaterman algorithm with a " - // + submat.getClass() + " Substitution Matrix: " + - // submat.getClass().getCanonicalName()); - - matrix = new MatrixEntry[length1 + 1][length2 + 1]; - alignment = new ArrayList(); - - for (int i = 0; i < length1+1; i++) { - for (int j = 0; j < length2+1; j++) { - matrix[i][j] = new MatrixEntry(); - } - } - - buildMatrix(); - traceback(); - - } - - - } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/NumberSequence.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/NumberSequence.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/NumberSequence.java (revision 1733) @@ -5,5 +5,5 @@ import java.util.Random; -public class NumberSequence implements Serializable{ +public class NumberSequence implements Serializable { /** * @@ -18,104 +18,13 @@ } - public int[] getSequence() { - return sequence; - } + // Searching occurrences of pattern + public LinkedList containsPattern(Match pattern) { + final LinkedList result = new LinkedList(); + int i = 0; + final int[] pat1 = pattern.getFirstSequence().getSequence(); + final int[] pat2 = pattern.getSecondSequence().getSequence(); - public void setSequence(int[] sequence) { - this.sequence = sequence; - } - - public void printSequence() { - for (int i = 0; i < sequence.length; i++) { - System.out.format("%5d", sequence[i]); - } - System.out.println(); - } - - public NumberSequence shuffle() { - NumberSequence result = new NumberSequence(sequence.length); - result.setId(getId()); - result.setSequence(this.sequence); - Random rgen = new Random(); - - for (int i = 0; i < result.sequence.length; i++) { - int randomPosition = rgen.nextInt(result.sequence.length); - int temp = result.sequence[i]; - result.sequence[i] = result.sequence[randomPosition]; - result.sequence[randomPosition] = temp; - } - return result; - - } - - //Recursive check if sequence contains pattern at position i - private boolean matches(int i, - int[] p1, - int[] p2 , - int ip1, - int ip2, - boolean jumped1, //True if there was a gap in Sequence 1 of the pattern - boolean jumped2, //True if there was a gap in Sequence 2 of the pattern - boolean hadSelection, //True if the last match was a selection - boolean matchseq1, - boolean matchseq2) { - - if(p1.length==ip1) { - return true; - } - if(p2.length==ip2) { - return true; - } - if(i==sequence.length) { - return false; - } - - boolean foundselection=(!(p1[ip1] == p2[ip2])&&!(p1[ip1]==-1||p2[ip2]==-1)); - boolean matchInFirstPattern = (p1[ip1]==sequence[i]); - boolean matchInSecondPattern = (p2[ip2]==sequence[i]); - - if(foundselection && hadSelection) { - if((matchInFirstPattern && matchseq1) || (matchInSecondPattern && matchseq2)){ - if(jumped1) { - return matches(i+1,p1,p2,ip1+1,ip2+2,false,false,foundselection,matchInFirstPattern,matchInSecondPattern); - } - if(jumped2) { - return matches(i+1,p1,p2,ip1+2,ip2+1,false,false,foundselection,matchInFirstPattern,matchInSecondPattern); - } - return matches(i+1,p1,p2,ip1+1,ip2+1,false,false,foundselection,matchInFirstPattern,matchInSecondPattern); - } - else { - return false; - } - } - - if((matchInFirstPattern||matchInSecondPattern) && jumped1) { - return matches(i+1,p1,p2,ip1+1,ip2+2,false,false,foundselection,matchInFirstPattern,matchInSecondPattern); - } - if((matchInFirstPattern||matchInSecondPattern) && jumped2) { - return matches(i+1,p1,p2,ip1+2,ip2+1,false,false,foundselection,matchInFirstPattern,matchInSecondPattern); - } - if(matchInFirstPattern||matchInSecondPattern) { - return matches(i+1,p1,p2,ip1+1,ip2+1,false,false,foundselection,matchInFirstPattern,matchInSecondPattern); - } - if(p1[ip1]==-1) { - return matches(i,p1,p2,ip1+1,ip2,true,false,false,false,false); - } - if(p2[ip2]==-1) { - return matches(i,p1,p2,ip1,ip2+1,false,true,false,false,false); - } - - return false; - } - - //Searching occurrences of pattern - public LinkedList containsPattern(Match pattern) { - LinkedList result = new LinkedList(); - int i = 0; - int[] pat1 = pattern.getFirstSequence().getSequence(); - int[] pat2 = pattern.getSecondSequence().getSequence(); - - while (i < sequence.length ) { - if(matches(i,pat1,pat2,0,0,false,false,false,false,false)) { + while (i < sequence.length) { + if (matches(i, pat1, pat2, 0, 0, false, false, false, false, false)) { result.add(i); } @@ -123,4 +32,17 @@ } return result; + } + + public boolean equals(NumberSequence n) { + final int[] seq = n.getSequence(); + if (n.size() != this.size()) { + return false; + } + for (int i = 0; i < n.size(); i++) { + if (seq[i] != this.sequence[i]) { + return false; + } + } + return true; } @@ -136,10 +58,85 @@ } - public int size() { - return sequence.length; + public int getId() { + return id; } - public int getId() { - return id; + public int[] getSequence() { + return sequence; + } + + // Recursive check if sequence contains pattern at position i + private boolean matches(int i, int[] p1, int[] p2, int ip1, int ip2, + boolean jumped1, // True if there was a gap in Sequence 1 of the + // pattern + boolean jumped2, // True if there was a gap in Sequence 2 of the + // pattern + boolean hadSelection, // True if the last match was a selection + boolean matchseq1, boolean matchseq2) { + + if (p1.length == ip1) { + return true; + } + if (p2.length == ip2) { + return true; + } + if (i == sequence.length) { + return false; + } + + final boolean foundselection = (!(p1[ip1] == p2[ip2]) && !((p1[ip1] == -1) || (p2[ip2] == -1))); + final boolean matchInFirstPattern = (p1[ip1] == sequence[i]); + final boolean matchInSecondPattern = (p2[ip2] == sequence[i]); + + if (foundselection && hadSelection) { + if ((matchInFirstPattern && matchseq1) + || (matchInSecondPattern && matchseq2)) { + if (jumped1) { + return matches(i + 1, p1, p2, ip1 + 1, ip2 + 2, false, + false, foundselection, matchInFirstPattern, + matchInSecondPattern); + } + if (jumped2) { + return matches(i + 1, p1, p2, ip1 + 2, ip2 + 1, false, + false, foundselection, matchInFirstPattern, + matchInSecondPattern); + } + return matches(i + 1, p1, p2, ip1 + 1, ip2 + 1, false, false, + foundselection, matchInFirstPattern, + matchInSecondPattern); + } else { + return false; + } + } + + if ((matchInFirstPattern || matchInSecondPattern) && jumped1) { + return matches(i + 1, p1, p2, ip1 + 1, ip2 + 2, false, false, + foundselection, matchInFirstPattern, matchInSecondPattern); + } + if ((matchInFirstPattern || matchInSecondPattern) && jumped2) { + return matches(i + 1, p1, p2, ip1 + 2, ip2 + 1, false, false, + foundselection, matchInFirstPattern, matchInSecondPattern); + } + if (matchInFirstPattern || matchInSecondPattern) { + return matches(i + 1, p1, p2, ip1 + 1, ip2 + 1, false, false, + foundselection, matchInFirstPattern, matchInSecondPattern); + } + if (p1[ip1] == -1) { + return matches(i, p1, p2, ip1 + 1, ip2, true, false, false, false, + false); + } + if (p2[ip2] == -1) { + return matches(i, p1, p2, ip1, ip2 + 1, false, true, false, false, + false); + } + + return false; + } + + public void printSequence() { + for (int i = 0; i < sequence.length; i++) { + System.out.format("%5d", sequence[i]); + } + System.out.println(); } @@ -148,15 +145,26 @@ } - public boolean equals(NumberSequence n) { - int[] seq = n.getSequence(); - if (n.size() != this.size()) { - return false; + public void setSequence(int[] sequence) { + this.sequence = sequence; + } + + public NumberSequence shuffle() { + final NumberSequence result = new NumberSequence(sequence.length); + result.setId(getId()); + result.setSequence(this.sequence); + final Random rgen = new Random(); + + for (int i = 0; i < result.sequence.length; i++) { + final int randomPosition = rgen.nextInt(result.sequence.length); + final int temp = result.sequence[i]; + result.sequence[i] = result.sequence[randomPosition]; + result.sequence[randomPosition] = temp; } - for (int i = 0; i < n.size(); i++) { - if (seq[i] != this.sequence[i]) { - return false; - } - } - return true; + return result; + + } + + public int size() { + return sequence.length; } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/SmithWaterman.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/SmithWaterman.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/SmithWaterman.java (revision 1733) @@ -38,4 +38,214 @@ private SubstitutionMatrix submat; + @Override + public void align(NumberSequence input1, NumberSequence input2, + SubstitutionMatrix submat, float threshold) { + this.input1 = input1.getSequence(); + this.input2 = input2.getSequence(); + length1 = input1.size(); + length2 = input2.size(); + this.submat = submat; + + // System.out.println("Starting SmithWaterman algorithm with a " + // + submat.getClass() + " Substitution Matrix: " + + // submat.getClass().getCanonicalName()); + + matrix = new MatrixEntry[length1 + 1][length2 + 1]; + alignment = new ArrayList(); + + for (int i = 0; i < (length1 + 1); i++) { + for (int j = 0; j < (length2 + 1); j++) { + matrix[i][j] = new MatrixEntry(); + } + } + + buildMatrix(); + traceback(); + + } + + /** + * Build the score matrix using dynamic programming. + */ + private void buildMatrix() { + if (submat.getGapPenalty() >= 0) { + throw new Error("Indel score must be negative"); + } + + // it's a gap + matrix[0][0].setScore(0); + matrix[0][0].setPrevious(null); // starting point + + // the first column + for (int j = 1; j < length2; j++) { + matrix[0][j].setScore(0); + matrix[0][j].setPrevious(matrix[0][j - 1]); + matrix[0][j].setYvalue(input2[j]); + matrix[0][j].setXvalue(Constants.GAP_SYMBOL); + } + // the first row + + for (int j = 1; j < length1; j++) { + matrix[j][0].setScore(0); + matrix[j][0].setPrevious(matrix[j - 1][0]); + matrix[j][0].setXvalue(input1[j]); + matrix[j][0].setYvalue(Constants.GAP_SYMBOL); + } + + for (int i = 1; i < length1; i++) { + + for (int j = 1; j < length2; j++) { + final double diagScore = matrix[i - 1][j - 1].getScore() + + similarity(i, j); + final double upScore = matrix[i][j - 1].getScore() + + submat.getGapPenalty(); + final double leftScore = matrix[i - 1][j].getScore() + + submat.getGapPenalty(); + + matrix[i][j].setScore(Math.max(diagScore, + Math.max(upScore, Math.max(leftScore, 0)))); + + // find the directions that give the maximum scores. + // TODO: Multiple directions are ignored, we choose the first + // maximum score + // True if we had a match + if (diagScore == matrix[i][j].getScore()) { + matrix[i][j].setPrevious(matrix[i - 1][j - 1]); + matrix[i][j].setXvalue(input1[i - 1]); + matrix[i][j].setYvalue(input2[j - 1]); + } + // true if we took an event from sequence x and not from y + if (leftScore == matrix[i][j].getScore()) { + matrix[i][j].setXvalue(input1[i - 1]); + matrix[i][j].setYvalue(Constants.GAP_SYMBOL); + matrix[i][j].setPrevious(matrix[i - 1][j]); + } + // true if we took an event from sequence y and not from x + if (upScore == matrix[i][j].getScore()) { + matrix[i][j].setXvalue(Constants.GAP_SYMBOL); + matrix[i][j].setYvalue(input2[j - 1]); + matrix[i][j].setPrevious(matrix[i][j - 1]); + } + if (0 == matrix[i][j].getScore()) { + matrix[i][j].setPrevious(matrix[0][0]); + matrix[i][j].setXvalue(-2); + matrix[i][j].setYvalue(-2); + } + } + + // Set the complete score cell + + } + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm + * #getAlignment() + */ + @Override + public ArrayList getAlignment() { + return alignment; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm + * #getAlignmentScore() + */ + @Override + public double getAlignmentScore() { + return getMaxScore(); + } + + @Override + public ArrayList getMatches() { + // TODO Auto-generated method stub + return null; + } + + /** + * Get the maximum value in the score matrix. + */ + @Override + public double getMaxScore() { + double maxScore = 0; + + // skip the first row and column + for (int i = 1; i <= length1; i++) { + for (int j = 1; j < length2; j++) { + if (matrix[i][j].getScore() > maxScore) { + maxScore = matrix[i][j].getScore(); + } + } + } + + return maxScore; + } + + @Override + public void printAlignment() { + MatrixEntry tmp = matrix[length1 + 1][0]; + String aligned1 = ""; + String aligned2 = ""; + int count = 0; + do { + String append1 = ""; + String append2 = ""; + + if (tmp.getXvalue() == Constants.GAP_SYMBOL) { + append1 = " ___"; + } else { + append1 = String.format("%5d", tmp.getXvalue()); + } + + if (tmp.getYvalue() == Constants.GAP_SYMBOL) { + append2 = " ___"; + } else { + append2 = String.format("%5d", tmp.getYvalue()); + } + if (count != 0) { + aligned1 = append1 + aligned1; + aligned2 = append2 + aligned2; + } + + tmp = tmp.getPrevious(); + count++; + + } while (tmp != null); + System.out.println(aligned1); + System.out.println(aligned2); + } + + /** + * print the dynmaic programming matrix + */ + @Override + public void printDPMatrix() { + System.out.print(" "); + for (int i = 1; i <= length1; i++) { + System.out.format("%5d", input1[i - 1]); + } + System.out.println(); + for (int j = 0; j <= length2; j++) { + if (j > 0) { + System.out.format("%5d ", input2[j - 1]); + } else { + System.out.print(" "); + } + for (int i = 0; i <= length1; i++) { + System.out.format("%4.1f ", matrix[i][j].getScore()); + } + System.out.println(); + } + } + + public void setAlignment(ArrayList alignment) { + this.alignment = alignment; + } /** @@ -53,115 +263,11 @@ } - /** - * Build the score matrix using dynamic programming. - */ - private void buildMatrix() { - if (submat.getGapPenalty() >= 0) { - throw new Error("Indel score must be negative"); - } - - // it's a gap - matrix[0][0].setScore(0); - matrix[0][0].setPrevious(null); // starting point - - // the first column - for (int j = 1; j < length2; j++) { - matrix[0][j].setScore(0); - matrix[0][j].setPrevious(matrix[0][j - 1]); - matrix[0][j].setYvalue(input2[j]); - matrix[0][j].setXvalue(Constants.GAP_SYMBOL); - } - // the first row - - for (int j = 1; j < length1; j++) { - matrix[j][0].setScore(0); - matrix[j][0].setPrevious(matrix[j - 1][0]); - matrix[j][0].setXvalue(input1[j]); - matrix[j][0].setYvalue(Constants.GAP_SYMBOL); - } - - for (int i = 1; i < length1; i++) { - - for (int j = 1; j < length2; j++) { - double diagScore = matrix[i - 1][j - 1].getScore() - + similarity(i, j); - double upScore = matrix[i][j - 1].getScore() - + submat.getGapPenalty(); - double leftScore = matrix[i - 1][j].getScore() - + submat.getGapPenalty(); - - matrix[i][j].setScore(Math.max(diagScore, - Math.max(upScore, Math.max(leftScore, 0)))); - - // find the directions that give the maximum scores. - // TODO: Multiple directions are ignored, we choose the first - // maximum score - // True if we had a match - if (diagScore == matrix[i][j].getScore()) { - matrix[i][j].setPrevious(matrix[i - 1][j - 1]); - matrix[i][j].setXvalue(input1[i - 1]); - matrix[i][j].setYvalue(input2[j - 1]); - } - // true if we took an event from sequence x and not from y - if (leftScore == matrix[i][j].getScore()) { - matrix[i][j].setXvalue(input1[i - 1]); - matrix[i][j].setYvalue(Constants.GAP_SYMBOL); - matrix[i][j].setPrevious(matrix[i - 1][j]); - } - // true if we took an event from sequence y and not from x - if (upScore == matrix[i][j].getScore()) { - matrix[i][j].setXvalue(Constants.GAP_SYMBOL); - matrix[i][j].setYvalue(input2[j - 1]); - matrix[i][j].setPrevious(matrix[i][j - 1]); - } - if (0 == matrix[i][j].getScore()) { - matrix[i][j].setPrevious(matrix[0][0]); - matrix[i][j].setXvalue(-2); - matrix[i][j].setYvalue(-2); - } - } - - // Set the complete score cell - - } - } - - /** - * Get the maximum value in the score matrix. - */ - public double getMaxScore() { - double maxScore = 0; - - // skip the first row and column - for (int i = 1; i <= length1; i++) { - for (int j = 1; j < length2; j++) { - if (matrix[i][j].getScore() > maxScore) { - maxScore = matrix[i][j].getScore(); - } - } - } - - return maxScore; - } - - /* - * (non-Javadoc) - * - * @see - * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm - * #getAlignmentScore() - */ - @Override - public double getAlignmentScore() { - return getMaxScore(); - } - public void traceback() { MatrixEntry tmp = matrix[length1][length2]; - int aligned1[] = new int[length1 + length2 + 2]; - int aligned2[] = new int[length1 + length2 + 2]; + final int aligned1[] = new int[length1 + length2 + 2]; + final int aligned2[] = new int[length1 + length2 + 2]; int count = 0; do { - if (length1 + length2 + 2 == count) { + if ((length1 + length2 + 2) == count) { Console.traceln(Level.WARNING, "Traceback longer than both sequences summed up!"); @@ -177,6 +283,6 @@ count--; // reverse order of the alignment - int reversed1[] = new int[count]; - int reversed2[] = new int[count]; + final int reversed1[] = new int[count]; + final int reversed2[] = new int[count]; for (int i = count - 1; i > 0; i--) { @@ -185,6 +291,6 @@ } - NumberSequence ns1 = new NumberSequence(reversed1.length); - NumberSequence ns2 = new NumberSequence(reversed2.length); + final NumberSequence ns1 = new NumberSequence(reversed1.length); + final NumberSequence ns2 = new NumberSequence(reversed2.length); ns1.setSequence(reversed1); ns2.setSequence(reversed2); @@ -194,106 +300,3 @@ } - public void printAlignment() { - MatrixEntry tmp = matrix[length1 + 1][0]; - String aligned1 = ""; - String aligned2 = ""; - int count = 0; - do { - String append1 = ""; - String append2 = ""; - - if (tmp.getXvalue() == Constants.GAP_SYMBOL) { - append1 = " ___"; - } else { - append1 = String.format("%5d", tmp.getXvalue()); - } - - if (tmp.getYvalue() == Constants.GAP_SYMBOL) { - append2 = " ___"; - } else { - append2 = String.format("%5d", tmp.getYvalue()); - } - if (count != 0) { - aligned1 = append1 + aligned1; - aligned2 = append2 + aligned2; - } - - tmp = tmp.getPrevious(); - count++; - - } while (tmp != null); - System.out.println(aligned1); - System.out.println(aligned2); - } - - /** - * print the dynmaic programming matrix - */ - public void printDPMatrix() { - System.out.print(" "); - for (int i = 1; i <= length1; i++) - System.out.format("%5d", input1[i - 1]); - System.out.println(); - for (int j = 0; j <= length2; j++) { - if (j > 0) - System.out.format("%5d ", input2[j - 1]); - else { - System.out.print(" "); - } - for (int i = 0; i <= length1; i++) { - System.out.format("%4.1f ", matrix[i][j].getScore()); - } - System.out.println(); - } - } - - /* - * (non-Javadoc) - * - * @see - * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm - * #getAlignment() - */ - @Override - public ArrayList getAlignment() { - return alignment; - } - - public void setAlignment(ArrayList alignment) { - this.alignment = alignment; - } - - @Override - public ArrayList getMatches() { - // TODO Auto-generated method stub - return null; - } - - @Override - public void align(NumberSequence input1, NumberSequence input2, SubstitutionMatrix submat, - float threshold) { - this.input1 = input1.getSequence(); - this.input2 = input2.getSequence(); - length1 = input1.size(); - length2 = input2.size(); - this.submat = submat; - - // System.out.println("Starting SmithWaterman algorithm with a " - // + submat.getClass() + " Substitution Matrix: " + - // submat.getClass().getCanonicalName()); - - matrix = new MatrixEntry[length1 + 1][length2 + 1]; - alignment = new ArrayList(); - - for (int i = 0; i < length1+1; i++) { - for (int j = 0; j < length2+1; j++) { - matrix[i][j] = new MatrixEntry(); - } - } - - buildMatrix(); - traceback(); - - } - } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/SmithWatermanRepeated.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/SmithWatermanRepeated.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/algorithms/SmithWatermanRepeated.java (revision 1733) @@ -5,9 +5,7 @@ import java.util.LinkedList; - import de.ugoe.cs.autoquest.tasktrees.alignment.matrix.SubstitutionMatrix; import de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.Constants; - public class SmithWatermanRepeated implements AlignmentAlgorithm { @@ -33,7 +31,6 @@ private MatrixEntry[][] matrix; - private ArrayList alignment; - + private float scoreThreshold; @@ -44,5 +41,302 @@ public SmithWatermanRepeated() { - + + } + + @Override + public void align(NumberSequence input1, NumberSequence input2, + SubstitutionMatrix submat, float threshold) { + + alignment = new ArrayList(); + alignment.add(input1); + alignment.add(input2); + + this.input1 = input1.getSequence(); + this.input2 = input2.getSequence(); + + length1 = input1.size(); + length2 = input2.size(); + this.submat = submat; + + // System.out.println("Starting SmithWaterman algorithm with a " + // + submat.getClass() + " Substitution Matrix: " + + // submat.getClass().getCanonicalName()); + this.scoreThreshold = threshold; + + matrix = new MatrixEntry[length1 + 2][length2 + 1]; + + for (int i = 0; i <= (length1 + 1); i++) { + for (int j = 0; j <= length2; j++) { + matrix[i][j] = new MatrixEntry(); + } + } + + // Console.traceln(Level.INFO,"Generating DP Matrix"); + buildMatrix(); + // Console.traceln(Level.INFO,"Doing traceback"); + traceback(); + } + + /** + * Build the score matrix using dynamic programming. + */ + private void buildMatrix() { + if (submat.getGapPenalty() >= 0) { + throw new Error("Indel score must be negative"); + } + + // it's a gap + matrix[0][0].setScore(0); + matrix[0][0].setPrevious(null); // starting point + matrix[0][0].setXvalue(Constants.UNMATCHED_SYMBOL); + matrix[0][0].setYvalue(Constants.UNMATCHED_SYMBOL); + + // the first column + for (int j = 1; j < length2; j++) { + matrix[0][j].setScore(0); + // We don't need to go back to [0][0] if we reached matrix[0][x], so + // just end here + // matrix[0][j].setPrevious(matrix[0][j-1]); + matrix[0][j].setPrevious(null); + } + + for (int i = 1; i < (length1 + 2); i++) { + + // Formula for first row: + // F(i,0) = max { F(i-1,0), F(i-1,j)-T j=1,...,m + + final double firstRowLeftScore = matrix[i - 1][0].getScore(); + // for sequences of length 1 + double tempMax; + int maxRowIndex; + if (length2 == 1) { + tempMax = matrix[i - 1][0].getScore(); + maxRowIndex = 0; + } else { + tempMax = matrix[i - 1][1].getScore(); + maxRowIndex = 1; + // position of the maximal score of the previous row + + for (int j = 2; j <= length2; j++) { + if (matrix[i - 1][j].getScore() > tempMax) { + tempMax = matrix[i - 1][j].getScore(); + maxRowIndex = j; + } + } + + } + + tempMax -= scoreThreshold; + matrix[i][0].setScore(Math.max(firstRowLeftScore, tempMax)); + if (tempMax == matrix[i][0].getScore()) { + matrix[i][0].setPrevious(matrix[i - 1][maxRowIndex]); + } + + if (firstRowLeftScore == matrix[i][0].getScore()) { + matrix[i][0].setPrevious(matrix[i - 1][0]); + } + + // The last additional score is not related to a character in the + // input sequence, it's the total score. Therefore we don't need to + // save something for it + // and can end here + if (i < (length1 + 1)) { + matrix[i][0].setXvalue(input1[i - 1]); + matrix[i][0].setYvalue(Constants.UNMATCHED_SYMBOL); + } else { + return; + } + + for (int j = 1; j <= length2; j++) { + final double diagScore = matrix[i - 1][j - 1].getScore() + + similarity(i, j); + final double upScore = matrix[i][j - 1].getScore() + + submat.getGapPenalty(); + final double leftScore = matrix[i - 1][j].getScore() + + submat.getGapPenalty(); + + matrix[i][j].setScore(Math.max( + diagScore, + Math.max(upScore, + Math.max(leftScore, matrix[i][0].getScore())))); + + // find the directions that give the maximum scores. + // TODO: Multiple directions are ignored, we choose the first + // maximum score + // True if we had a match + if (diagScore == matrix[i][j].getScore()) { + matrix[i][j].setPrevious(matrix[i - 1][j - 1]); + matrix[i][j].setXvalue(input1[i - 1]); + matrix[i][j].setYvalue(input2[j - 1]); + } + // true if we took an event from sequence x and not from y + if (leftScore == matrix[i][j].getScore()) { + matrix[i][j].setXvalue(input1[i - 1]); + matrix[i][j].setYvalue(Constants.GAP_SYMBOL); + matrix[i][j].setPrevious(matrix[i - 1][j]); + } + // true if we took an event from sequence y and not from x + if (upScore == matrix[i][j].getScore()) { + matrix[i][j].setXvalue(Constants.GAP_SYMBOL); + matrix[i][j].setYvalue(input2[j - 1]); + matrix[i][j].setPrevious(matrix[i][j - 1]); + } + // true if we ended a matching region + if (matrix[i][0].getScore() == matrix[i][j].getScore()) { + matrix[i][j].setPrevious(matrix[i][0]); + matrix[i][j].setXvalue(input1[i - 1]); + matrix[i][j].setYvalue(Constants.UNMATCHED_SYMBOL); + } + } + + // Set the complete score cell + + } + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm + * #getAlignment() + */ + @Override + public ArrayList getAlignment() { + return alignment; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm + * #getAlignmentScore() + */ + @Override + public double getAlignmentScore() { + return matrix[length1 + 1][0].getScore(); + } + + @Override + public ArrayList getMatches() { + final ArrayList result = new ArrayList(); + + // both alignment sequences should be equally long + int i = 0; + final int[] seq1 = alignment.get(0).getSequence(); + final int[] seq2 = alignment.get(1).getSequence(); + int start = 0; + while (i < seq1.length) { + if (seq2[i] != Constants.UNMATCHED_SYMBOL) { + start = i; + int count = 0; + while ((i < seq2.length) + && (seq2[i] != Constants.UNMATCHED_SYMBOL)) { + i++; + count++; + } + // I am really missing memcpy here? How does one do this better + // in java? + final int[] tmp1 = new int[count]; + final int[] tmp2 = new int[count]; + for (int j = 0; j < count; j++) { + tmp1[j] = seq1[start + j]; + tmp2[j] = seq2[start + j]; + } + final NumberSequence tmpns1 = new NumberSequence(count); + final NumberSequence tmpns2 = new NumberSequence(count); + tmpns1.setSequence(tmp1); + tmpns2.setSequence(tmp2); + final Match tmpal = new Match(); + tmpal.setFirstSequence(tmpns1); + tmpal.setSecondSequence(tmpns2); + // tmpal.addOccurence(new + // MatchOccurence(start,alignment.get(0).getId())); + // tmpal.addOccurence(new + // MatchOccurence(start,alignment.get(1).getId())); + result.add(tmpal); + } + i++; + } + return result; + } + + /** + * Get the maximum value in the score matrix. + */ + @Override + public double getMaxScore() { + double maxScore = 0; + + // skip the first row and column + for (int i = 1; i <= length1; i++) { + for (int j = 1; j <= length2; j++) { + if (matrix[i][j].getScore() > maxScore) { + maxScore = matrix[i][j].getScore(); + } + } + } + + return maxScore; + } + + @Override + public void printAlignment() { + final int[] tmp1 = alignment.get(0).getSequence(); + final int[] tmp2 = alignment.get(1).getSequence(); + for (int i = 0; i < tmp1.length; i++) { + if (tmp1[i] == Constants.GAP_SYMBOL) { + System.out.print(" ___"); + } else if (tmp1[i] == Constants.UNMATCHED_SYMBOL) { + System.out.print(" ..."); + } else { + System.out.format("%5d", tmp1[i]); + } + + } + System.out.println(); + for (int i = 0; i < tmp2.length; i++) { + if (tmp2[i] == Constants.GAP_SYMBOL) { + System.out.print(" ___"); + } else if (tmp2[i] == Constants.UNMATCHED_SYMBOL) { + System.out.print(" ..."); + } else { + System.out.format("%5d", tmp2[i]); + } + + } + System.out.println(); + + } + + /** + * print the dynmaic programming matrix + */ + @Override + public void printDPMatrix() { + System.out.print(" "); + for (int i = 1; i <= length1; i++) { + System.out.format("%5d", input1[i - 1]); + } + System.out.println(); + for (int j = 0; j <= length2; j++) { + if (j > 0) { + System.out.format("%5d ", input2[j - 1]); + } else { + System.out.print(" "); + } + for (int i = 0; i <= (length1 + 1); i++) { + if ((i < (length1 + 1)) || ((i == (length1 + 1)) && (j == 0))) { + System.out.format("%4.1f ", matrix[i][j].getScore()); + } + + } + System.out.println(); + } + } + + public void setAlignment(ArrayList alignment) { + this.alignment = alignment; } @@ -57,331 +351,46 @@ * @return Cost of substitution of the character in str1 by the one in str2 */ - private double similarity(int i, int j) { + private double similarity(int i, int j) { return submat.getScore(input1[i - 1], input2[j - 1]); } - /** - * Build the score matrix using dynamic programming. - */ - private void buildMatrix() { - if (submat.getGapPenalty() >= 0) { - throw new Error("Indel score must be negative"); - } - - // it's a gap - matrix[0][0].setScore(0); - matrix[0][0].setPrevious(null); // starting point - matrix[0][0].setXvalue(Constants.UNMATCHED_SYMBOL); - matrix[0][0].setYvalue(Constants.UNMATCHED_SYMBOL); - - // the first column - for (int j = 1; j < length2; j++) { - matrix[0][j].setScore(0); - //We don't need to go back to [0][0] if we reached matrix[0][x], so just end here - //matrix[0][j].setPrevious(matrix[0][j-1]); - matrix[0][j].setPrevious(null); - } - - - - for (int i = 1; i < length1 + 2; i++) { - - // Formula for first row: - // F(i,0) = max { F(i-1,0), F(i-1,j)-T j=1,...,m - - double firstRowLeftScore = matrix[i-1][0].getScore(); - //for sequences of length 1 - double tempMax; - int maxRowIndex; - if(length2 == 1) { - tempMax = matrix[i-1][0].getScore(); - maxRowIndex = 0; - } else { - tempMax = matrix[i-1][1].getScore(); - maxRowIndex = 1; - //position of the maximal score of the previous row - - for(int j = 2; j <= length2;j++) { - if(matrix[i-1][j].getScore() > tempMax) { - tempMax = matrix[i-1][j].getScore(); - maxRowIndex = j; - } - } - - } - - tempMax -= scoreThreshold; - matrix[i][0].setScore(Math.max(firstRowLeftScore, tempMax)); - if(tempMax == matrix[i][0].getScore()){ - matrix[i][0].setPrevious(matrix[i-1][maxRowIndex]); - } - - if(firstRowLeftScore == matrix[i][0].getScore()) { - matrix[i][0].setPrevious(matrix[i-1][0]); - } - - //The last additional score is not related to a character in the input sequence, it's the total score. Therefore we don't need to save something for it - //and can end here - if(i maxScore) { - maxScore = matrix[i][j].getScore(); - } - } - } - - return maxScore; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.alignment.algorithms.AlignmentAlgorithm#getAlignmentScore() - */ - @Override - public double getAlignmentScore() { - return matrix[length1+1][0].getScore(); - } - public void traceback() { - MatrixEntry tmp = matrix[length1+1][0].getPrevious(); - LinkedList aligned1 = new LinkedList(); - LinkedList aligned2 = new LinkedList(); + MatrixEntry tmp = matrix[length1 + 1][0].getPrevious(); + final LinkedList aligned1 = new LinkedList(); + final LinkedList aligned2 = new LinkedList(); while (tmp.getPrevious() != null) { - + aligned1.add(new Integer(tmp.getXvalue())); aligned2.add(new Integer(tmp.getYvalue())); tmp = tmp.getPrevious(); - } - + } + // reverse order of the alignment - int reversed1[] = new int[aligned1.size()]; - int reversed2[] = new int[aligned2.size()]; + final int reversed1[] = new int[aligned1.size()]; + final int reversed2[] = new int[aligned2.size()]; int count = 0; - for (Iterator it = aligned1.iterator(); it.hasNext();) { + for (final Iterator it = aligned1.iterator(); it.hasNext();) { count++; reversed1[reversed1.length - count] = it.next(); - + } count = 0; - for (Iterator it = aligned2.iterator(); it.hasNext();) { + for (final Iterator it = aligned2.iterator(); it.hasNext();) { count++; reversed2[reversed2.length - count] = it.next(); } - - NumberSequence ns1 = new NumberSequence(reversed1.length); - NumberSequence ns2 = new NumberSequence(reversed2.length); + final NumberSequence ns1 = new NumberSequence(reversed1.length); + final NumberSequence ns2 = new NumberSequence(reversed2.length); ns1.setSequence(reversed1); ns2.setSequence(reversed2); ns1.setId(alignment.get(0).getId()); ns2.setId(alignment.get(1).getId()); - + alignment.set(0, ns1); alignment.set(1, ns2); } - - - - public void printAlignment() { - int[] tmp1 = alignment.get(0).getSequence(); - int[] tmp2 = alignment.get(1).getSequence(); - for (int i=0; i< tmp1.length;i++) { - if(tmp1[i] == Constants.GAP_SYMBOL) { - System.out.print(" ___"); - } - else if(tmp1[i] == Constants.UNMATCHED_SYMBOL) { - System.out.print(" ..."); - } - else { - System.out.format("%5d", tmp1[i]); - } - - } - System.out.println(); - for (int i=0; i< tmp2.length;i++) { - if(tmp2[i] == Constants.GAP_SYMBOL) { - System.out.print(" ___"); - } - else if(tmp2[i] == Constants.UNMATCHED_SYMBOL) { - System.out.print(" ..."); - } - else { - System.out.format("%5d", tmp2[i]); - } - - } - System.out.println(); - - - - } - - public ArrayList getMatches() { - ArrayList result = new ArrayList(); - - //both alignment sequences should be equally long - int i = 0; - int[] seq1 = alignment.get(0).getSequence(); - int[] seq2 = alignment.get(1).getSequence(); - int start = 0; - while (i < seq1.length){ - if(seq2[i] != Constants.UNMATCHED_SYMBOL) { - start = i; - int count = 0; - while(i < seq2.length && seq2[i] != Constants.UNMATCHED_SYMBOL) { - i++; - count++; - } - //I am really missing memcpy here? How does one do this better in java? - int[] tmp1 = new int[count]; - int[] tmp2 = new int[count]; - for (int j = 0; j 0) - System.out.format("%5d ",input2[j - 1]); - else{ - System.out.print(" "); - } - for (int i = 0; i <= length1 + 1; i++) { - if((i getAlignment() { - return alignment; - } - - public void setAlignment(ArrayList alignment) { - this.alignment = alignment; - } - - @Override - public void align(NumberSequence input1, NumberSequence input2, SubstitutionMatrix submat, - float threshold) { - - alignment = new ArrayList(); - alignment.add(input1); - alignment.add(input2); - - this.input1=input1.getSequence(); - this.input2=input2.getSequence(); - - length1 = input1.size(); - length2 = input2.size(); - this.submat = submat; - - //System.out.println("Starting SmithWaterman algorithm with a " - // + submat.getClass() + " Substitution Matrix: " + submat.getClass().getCanonicalName()); - this.scoreThreshold = threshold; - - matrix = new MatrixEntry[length1+2][length2+1]; - - - for (int i = 0; i <= length1+1; i++) { - for(int j = 0; j<= length2; j++) { - matrix[i][j] = new MatrixEntry(); - } - } - - //Console.traceln(Level.INFO,"Generating DP Matrix"); - buildMatrix(); - //Console.traceln(Level.INFO,"Doing traceback"); - traceback(); - } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/DifferenceSubstitutionMatrix.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/DifferenceSubstitutionMatrix.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/DifferenceSubstitutionMatrix.java (revision 1733) @@ -9,5 +9,4 @@ import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; - /** * @author Ralph Krimmel @@ -16,34 +15,16 @@ public class DifferenceSubstitutionMatrix implements SubstitutionMatrix { - private int[] input1; - private int[] input2; - private int maxValue; - - public DifferenceSubstitutionMatrix(int[] input1,int[] input2) { + private final int[] input1; + private final int[] input2; + private final int maxValue; + + public DifferenceSubstitutionMatrix(int[] input1, int[] input2) { this.input1 = input1; this.input2 = input2; this.maxValue = getMaxValue(); } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.plugin.alignment.SubstitutionMatrix#getDistance(int, int) - */ - public float getScore(int pos1, int pos2) { - return maxValue - (input1[pos1] - input2[pos2]); - } - - private int getMaxValue() { - int max = input1[0]; - for (int i=0; i < input1.length; i++) { - if(input1[i] > max) { - max = input1[i]; - } - } - for (int j=0; j < input2.length; j++) { - if(input2[j] > max) { - max = input2[j]; - } - } - return max; + + @Override + public void generate(HashSet uniqueTasks) { } @@ -53,7 +34,29 @@ } + private int getMaxValue() { + int max = input1[0]; + for (int i = 0; i < input1.length; i++) { + if (input1[i] > max) { + max = input1[i]; + } + } + for (int j = 0; j < input2.length; j++) { + if (input2[j] > max) { + max = input2[j]; + } + } + return max; + } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.plugin.alignment.SubstitutionMatrix#getDistance(int, + * int) + */ @Override - public void generate(HashSet uniqueTasks) { + public float getScore(int pos1, int pos2) { + return maxValue - (input1[pos1] - input2[pos2]); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/DummySubstitutionMatrix.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/DummySubstitutionMatrix.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/DummySubstitutionMatrix.java (revision 1733) @@ -9,11 +9,5 @@ @Override - public float getScore(int pos1, int pos2) { - if(pos1==pos2) { - return 1; - } - else { - return 0; - } + public void generate(HashSet uniqueTasks) { } @@ -24,5 +18,10 @@ @Override - public void generate(HashSet uniqueTasks) { + public float getScore(int pos1, int pos2) { + if (pos1 == pos2) { + return 1; + } else { + return 0; + } } @@ -30,7 +29,6 @@ public void update(LinkedList newlyGeneratedTasks) { // TODO Auto-generated method stub - + } - } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/DynamicTriangleMatrix.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/DynamicTriangleMatrix.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/DynamicTriangleMatrix.java (revision 1733) @@ -5,56 +5,55 @@ //Must be initialized! public class DynamicTriangleMatrix implements ITriangleMatrix { - - private ArrayList matrix; + + private final ArrayList matrix; protected int size; private float initalizationValue; - - - - //Increases the size - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#increaseSize(int) + + public DynamicTriangleMatrix(int size) { + this.size = size; + matrix = new ArrayList(); + matrix.ensureCapacity(size * (size + (1 / 2))); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#get(int, + * int) + */ + @Override + public float get(int first, int second) { + final int row = Math.min(first, second); + final int col = Math.max(first, second); + return matrix.get((row * size) + - (((row * (row + 1)) / 2) - (size - col))); + + } + + // Increases the size + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#increaseSize + * (int) */ @Override public void increaseSize(int count) { - int oldsize = size; + final int oldsize = size; this.size += count; - matrix.ensureCapacity(size*(size+1/2)); - for(int i=0;i<(oldsize*count)+(count*(count+1)/2);i++) { + matrix.ensureCapacity(size * (size + (1 / 2))); + for (int i = 0; i < ((oldsize * count) + ((count * (count + 1)) / 2)); i++) { matrix.add(this.initalizationValue); } } - - public DynamicTriangleMatrix(int size) { - this.size = size; - matrix = new ArrayList(); - matrix.ensureCapacity(size*(size+1/2)); - } - - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#get(int, int) - */ - @Override - public float get(int first, int second) { - int row = Math.min(first, second); - int col = Math.max(first, second); - return matrix.get(row*size-(row*(row+1)/2 - (size-col))); - - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#set(int, int, float) - */ - @Override - public void set(int first, int second, float value) { - int row = Math.min(first, second); - int col = Math.max(first, second); - matrix.set(row*size-(row*(row+1)/2 - (size-col)),value); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#initialize(float) + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#initialize + * (float) */ @Override @@ -62,12 +61,35 @@ this.initalizationValue = value; matrix.clear(); - for (int i=0; i < this.size*(this.size+1)/2; i++) { + for (int i = 0; i < ((this.size * (this.size + 1)) / 2); i++) { matrix.add(value); } } - - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#toString() + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#set(int, + * int, float) + */ + @Override + public void set(int first, int second, float value) { + final int row = Math.min(first, second); + final int col = Math.max(first, second); + matrix.set((row * size) - (((row * (row + 1)) / 2) - (size - col)), + value); + } + + @Override + public int size() { + return size; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.alignment.matrix.ITriangleMatrix#toString + * () */ @Override @@ -75,14 +97,13 @@ String result = ""; for (int i = 0; i < size; i++) { - for(int j = 0; j< size; j++) { - if(i eventlist; - - public LinkedList getEventlist() { - return eventlist; +public class EventTaskInstancesListGenerator extends + DefaultTaskTraversingVisitor { + + private LinkedList eventlist; + + public EventTaskInstancesListGenerator() { + eventlist = new LinkedList(); + } + + public LinkedList getEventlist() { + return eventlist; + } + + public void setEventlist(LinkedList eventlist) { + this.eventlist = eventlist; + } + + @Override + public void visit(IEventTask eventTask) { + if (eventTask.getInstances().size() > 0) { + final IEventTaskInstance eti = (IEventTaskInstance) eventTask + .getInstances().iterator().next(); + // System.out.println("Adding eventtaskinstance to list: " + eti); + eventlist.add(eti); } + } - public void setEventlist(LinkedList eventlist) { - this.eventlist = eventlist; - } - - @Override - public void visit(IEventTask eventTask) { - if(eventTask.getInstances().size() > 0) { - IEventTaskInstance eti = (IEventTaskInstance) eventTask.getInstances().iterator().next(); - //System.out.println("Adding eventtaskinstance to list: " + eti); - eventlist.add(eti); - } - } - - public EventTaskInstancesListGenerator() { - eventlist = new LinkedList(); - } - } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/ITriangleMatrix.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/ITriangleMatrix.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/ITriangleMatrix.java (revision 1733) @@ -3,16 +3,17 @@ public interface ITriangleMatrix { - //Increases the size + public abstract float get(int first, int second); + + // Increases the size public abstract void increaseSize(int count) throws Exception; - public abstract float get(int first, int second); + public abstract void initialize(float value); public abstract void set(int first, int second, float value); - public abstract void initialize(float value); + public abstract int size(); + @Override public abstract String toString(); - public abstract int size(); - } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/NearbySubstitutionMatrix.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/NearbySubstitutionMatrix.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/NearbySubstitutionMatrix.java (revision 1733) @@ -15,34 +15,13 @@ public class NearbySubstitutionMatrix implements SubstitutionMatrix { - private int[] input1; - private int[] input2; - private int range; - - public NearbySubstitutionMatrix(int[] input1,int[] input2, int range) { + private final int[] input1; + private final int[] input2; + private final int range; + + public NearbySubstitutionMatrix(int[] input1, int[] input2, int range) { this.input1 = input1; this.input2 = input2; this.range = range; } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.plugin.alignment.SubstitutionMatrix#getDistance(int, int) - */ - public float getScore(int pos1, int pos2) { - int difference = Math.abs(input1[pos1]-input2[pos2]); - if(difference < range) { - return range-difference; - } - else { - return -range; - } - } - - - @Override - public float getGapPenalty() { - return -range-1; - } - - @Override @@ -51,8 +30,28 @@ @Override + public float getGapPenalty() { + return -range - 1; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.plugin.alignment.SubstitutionMatrix#getDistance(int, + * int) + */ + @Override + public float getScore(int pos1, int pos2) { + final int difference = Math.abs(input1[pos1] - input2[pos2]); + if (difference < range) { + return range - difference; + } else { + return -range; + } + } + + @Override public void update(LinkedList newlyGeneratedTasks) { } - - } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/ObjectDistanceSubstitionMatrix.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/ObjectDistanceSubstitionMatrix.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/ObjectDistanceSubstitionMatrix.java (revision 1733) @@ -17,7 +17,6 @@ import de.ugoe.cs.util.console.Console; - - -public class ObjectDistanceSubstitionMatrix implements SubstitutionMatrix,Serializable { +public class ObjectDistanceSubstitionMatrix implements SubstitutionMatrix, + Serializable { /** @@ -25,18 +24,17 @@ */ private static final long serialVersionUID = -4253258274617754083L; - private HashMap idmapping; + private final HashMap idmapping; private ITriangleMatrix matrix; private HashSet uniqueTasks; private float gapPenalty; private int index = 0; - private HashMap> etisOfTasks; + private final HashMap> etisOfTasks; private boolean calculateNonTaskInstances = true; private int firstRoundMaxIndex = 0; - private double positiveThreshold; - - public ObjectDistanceSubstitionMatrix( - float positiveThreshold, int gapPenalty, - boolean calculateNonTaskInstances) { + private final double positiveThreshold; + + public ObjectDistanceSubstitionMatrix(float positiveThreshold, + int gapPenalty, boolean calculateNonTaskInstances) { this.positiveThreshold = positiveThreshold; idmapping = new HashMap(); @@ -45,61 +43,4 @@ this.calculateNonTaskInstances = calculateNonTaskInstances; - } - - public float getGapPenalty() { - return gapPenalty; - } - - public void setGapPenalty(float gapPenalty) { - this.gapPenalty = gapPenalty; - } - - //TODO: Merge this with updateEventTaskInstances - private void searchEventTaskInstances() { - for (Iterator it = uniqueTasks.iterator(); it.hasNext();) { - ITask task = it.next(); - if (!(task instanceof IEventTask)) { - EventTaskInstancesListGenerator etlg = new EventTaskInstancesListGenerator(); - task.accept(etlg); - LinkedList eventTaskInstances = etlg - .getEventlist(); - etisOfTasks.put(task.getId(), eventTaskInstances); - } - } - } - - public void updateEventTaskInstances(LinkedList newTasks){ - for (Iterator it = newTasks.iterator();it.hasNext();) { - ITask task = it.next(); - if (!(task instanceof IEventTask)) { - EventTaskInstancesListGenerator etlg = new EventTaskInstancesListGenerator(); - task.accept(etlg); - LinkedList eventTaskInstances = etlg - .getEventlist(); - etisOfTasks.put(task.getId(), eventTaskInstances); - } - } - } - - //Just Calculate the distance between the new tasks and the matrix. - public void update(LinkedList newTasks) { - - if (this.calculateNonTaskInstances) { - try { - matrix.increaseSize(newTasks.size()); - System.out.println("Subsitution matrix size is now " + matrix.size()*(matrix.size()+1)/2); - Console.traceln(Level.INFO, "searching EventTasks in Tasks"); - } catch (Exception e) { - Console.logException(e); - } - this.updateEventTaskInstances(newTasks); - for(Iterator it = newTasks.iterator();it.hasNext();) { - ITask task1 = it.next(); - for (Iterator jt = uniqueTasks.iterator(); jt.hasNext();) { - ITask task2 = jt.next(); - computeDistance(task1,task2); - } - } - } } @@ -112,16 +53,14 @@ // We just need to the first instance here if (task1.getInstances().size() > 0) { - ti1 = (ITaskInstance) task1.getInstances().iterator() - .next(); + ti1 = task1.getInstances().iterator().next(); } if (task2.getInstances().size() > 0) { - ti2 = (ITaskInstance) task2.getInstances().iterator() - .next(); + ti2 = task2.getInstances().iterator().next(); } IEventTaskInstance eti1 = null; IEventTaskInstance eti2 = null; - if (ti1 instanceof IEventTaskInstance - && ti2 instanceof IEventTaskInstance) { + if ((ti1 instanceof IEventTaskInstance) + && (ti2 instanceof IEventTaskInstance)) { eti1 = (IEventTaskInstance) ti1; index1 = getIndex(eti1); @@ -129,7 +68,7 @@ index2 = getIndex(eti2); distance = distanceBetweenInstances(eti1, eti2); - } else if (ti1 instanceof IEventTaskInstance + } else if ((ti1 instanceof IEventTaskInstance) && !(ti2 instanceof IEventTaskInstance)) { - task1 = ((ITaskInstance) ti1).getTask(); + task1 = ti1.getTask(); index2 = getIndex(task2); eti1 = (IEventTaskInstance) ti1; @@ -137,5 +76,5 @@ distance = distanceBetweenTaskAndInstance(task2, eti1); } else if (!(ti1 instanceof IEventTaskInstance) - && ti2 instanceof IEventTaskInstance) { + && (ti2 instanceof IEventTaskInstance)) { index1 = getIndex(task1); eti2 = (IEventTaskInstance) ti2; @@ -152,6 +91,58 @@ matrix.set(index1, index2, distance); } - - + + private float distanceBetweenInstances(IEventTaskInstance eti1, + IEventTaskInstance eti2) { + final IGUIElement first = (IGUIElement) eti1.getEvent().getTarget(); + final IGUIElement second = (IGUIElement) eti2.getEvent().getTarget(); + float distance = -1 * AlignmentHelpers.distanceBetween(first, second); + distance += positiveThreshold; + return distance; + } + + private float distanceBetweenTaskAndInstance(ITask task1, + IEventTaskInstance eti1) { + if (this.calculateNonTaskInstances) { + float tmpDistance = 0; + // System.out.println(etisOfTasks); + final LinkedList eventTaskInstances = etisOfTasks + .get(task1.getId()); + for (final Iterator it = eventTaskInstances + .iterator(); it.hasNext();) { + final IEventTaskInstance eti2 = it.next(); + // int taskId1 = eti1.getTask().getId(); + // int taskId2 = eti2.getTask().getId(); + // if (scoreExists(taskId1, taskId2)) { + // tmpDistance += getScore(taskId1, taskId2); + // } else { + final float dist = distanceBetweenInstances(eti1, eti2); + matrix.set(getIndex(eti1), getIndex(eti2), dist); + tmpDistance += dist; + // } + } + return tmpDistance / eventTaskInstances.size(); + } else { + return 0; + } + } + + private float distanceBetweenTasks(ITask task1, ITask task2) { + if (this.calculateNonTaskInstances) { + final LinkedList eventTaskInstances = etisOfTasks + .get(task1.getId()); + float tmpDistance = 0; + for (final Iterator it = eventTaskInstances + .iterator(); it.hasNext();) { + final IEventTaskInstance eti1 = it.next(); + tmpDistance += distanceBetweenTaskAndInstance(task2, eti1); + } + + return tmpDistance / eventTaskInstances.size(); + } else { + return 0; + } + } + + @Override public void generate(HashSet uniqueTasks) { this.uniqueTasks = uniqueTasks; @@ -160,92 +151,30 @@ Console.traceln(Level.INFO, "searching EventTasks in Tasks"); searchEventTaskInstances(); - } - else{ - matrix = new StaticTriangleMatrix(uniqueTasks.size()+1); + } else { + matrix = new StaticTriangleMatrix(uniqueTasks.size() + 1); } matrix.initialize(0); - - int count=0; - int size=uniqueTasks.size(); - for (Iterator it = uniqueTasks.iterator(); it.hasNext();) { - ITask task1 = it.next(); + + int count = 0; + final int size = uniqueTasks.size(); + for (final Iterator it = uniqueTasks.iterator(); it.hasNext();) { + final ITask task1 = it.next(); count++; - if((count%(size/100)==0)) { - Console.traceln(Level.INFO,(Math.round((float) count/size*100))+ "%"); - } - for (Iterator jt = uniqueTasks.iterator(); jt.hasNext();) { - ITask task2 = jt.next(); - computeDistance(task1,task2); - } - } - this.firstRoundMaxIndex=index; - } - - - - - - - private float distanceBetweenTaskAndInstance(ITask task1, - IEventTaskInstance eti1) { - if (this.calculateNonTaskInstances) { - float tmpDistance = 0; - //System.out.println(etisOfTasks); - LinkedList eventTaskInstances = etisOfTasks - .get(task1.getId()); - for (Iterator it = eventTaskInstances - .iterator(); it.hasNext();) { - IEventTaskInstance eti2 = it.next(); - //int taskId1 = eti1.getTask().getId(); - //int taskId2 = eti2.getTask().getId(); - //if (scoreExists(taskId1, taskId2)) { - // tmpDistance += getScore(taskId1, taskId2); - //} else { - float dist = distanceBetweenInstances(eti1, eti2); - matrix.set(getIndex(eti1), getIndex(eti2), dist); - tmpDistance += dist; - //} - } - return tmpDistance / eventTaskInstances.size(); - } else { - return 0; - } - } - - //public boolean scoreExists(int id, int id2) { - //return idmapping.containsKey(id) && idmapping.containsKey(id2); - // return false; - //} - - private float distanceBetweenTasks(ITask task1, ITask task2) { - if (this.calculateNonTaskInstances) { - LinkedList eventTaskInstances = etisOfTasks - .get(task1.getId()); - float tmpDistance = 0; - for (Iterator it = eventTaskInstances - .iterator(); it.hasNext();) { - IEventTaskInstance eti1 = it.next(); - tmpDistance += distanceBetweenTaskAndInstance(task2, eti1); - } - - return tmpDistance / eventTaskInstances.size(); - } else { - return 0; - } - } - - synchronized private int getIndex(ITask task) { - int tempindex = -1; - - if (!idmapping.containsKey(task.getId())) { - - idmapping.put(task.getId(), index); - tempindex = index; - index++; - } else { - tempindex = idmapping.get(task.getId()); - } - - return tempindex; + if (((count % (size / 100)) == 0)) { + Console.traceln(Level.INFO, + (Math.round(((float) count / size) * 100)) + "%"); + } + for (final Iterator jt = uniqueTasks.iterator(); jt + .hasNext();) { + final ITask task2 = jt.next(); + computeDistance(task1, task2); + } + } + this.firstRoundMaxIndex = index; + } + + @Override + public float getGapPenalty() { + return gapPenalty; } @@ -260,35 +189,103 @@ } return tempindex; + } + + synchronized private int getIndex(ITask task) { + int tempindex = -1; + + if (!idmapping.containsKey(task.getId())) { + + idmapping.put(task.getId(), index); + tempindex = index; + index++; + } else { + tempindex = idmapping.get(task.getId()); + } + + return tempindex; + } + + // public boolean scoreExists(int id, int id2) { + // return idmapping.containsKey(id) && idmapping.containsKey(id2); + // return false; + // } + + @Override + public float getScore(int taskId1, int taskId2) { + if ((taskId1 == Constants.GAP_SYMBOL) + || (taskId1 == Constants.UNMATCHED_SYMBOL) + || (taskId2 == Constants.GAP_SYMBOL) + || (taskId2 == Constants.UNMATCHED_SYMBOL)) { + return 0; + } else if ((this.calculateNonTaskInstances == false) + && ((taskId1 > this.firstRoundMaxIndex) || (taskId2 > this.firstRoundMaxIndex))) { + return 0; + } else { + final Integer first = idmapping.get(taskId1); + final Integer second = idmapping.get(taskId2); + return matrix.get(first, second); + } + + } + + // TODO: Merge this with updateEventTaskInstances + private void searchEventTaskInstances() { + for (final Iterator it = uniqueTasks.iterator(); it.hasNext();) { + final ITask task = it.next(); + if (!(task instanceof IEventTask)) { + final EventTaskInstancesListGenerator etlg = new EventTaskInstancesListGenerator(); + task.accept(etlg); + final LinkedList eventTaskInstances = etlg + .getEventlist(); + etisOfTasks.put(task.getId(), eventTaskInstances); + } + } + } + + public void setGapPenalty(float gapPenalty) { + this.gapPenalty = gapPenalty; }; - private float distanceBetweenInstances(IEventTaskInstance eti1, - IEventTaskInstance eti2) { - IGUIElement first = (IGUIElement) eti1.getEvent().getTarget(); - IGUIElement second = (IGUIElement) eti2.getEvent().getTarget(); - float distance = -1 * AlignmentHelpers.distanceBetween(first, second); - distance += positiveThreshold; - return distance; - } - + @Override public String toString() { return matrix.toString(); } - public float getScore(int taskId1, int taskId2) { - if (taskId1 == Constants.GAP_SYMBOL - || taskId1 == Constants.UNMATCHED_SYMBOL - || taskId2 == Constants.GAP_SYMBOL - || taskId2 == Constants.UNMATCHED_SYMBOL) { - return 0; - } else if(this.calculateNonTaskInstances==false && - (taskId1>this.firstRoundMaxIndex - || taskId2>this.firstRoundMaxIndex)) { - return 0; - } else { - Integer first = idmapping.get(taskId1); - Integer second = idmapping.get(taskId2); - return matrix.get(first, second); - } - + // Just Calculate the distance between the new tasks and the matrix. + @Override + public void update(LinkedList newTasks) { + + if (this.calculateNonTaskInstances) { + try { + matrix.increaseSize(newTasks.size()); + System.out.println("Subsitution matrix size is now " + + ((matrix.size() * (matrix.size() + 1)) / 2)); + Console.traceln(Level.INFO, "searching EventTasks in Tasks"); + } catch (final Exception e) { + Console.logException(e); + } + this.updateEventTaskInstances(newTasks); + for (final Iterator it = newTasks.iterator(); it.hasNext();) { + final ITask task1 = it.next(); + for (final Iterator jt = uniqueTasks.iterator(); jt + .hasNext();) { + final ITask task2 = jt.next(); + computeDistance(task1, task2); + } + } + } + } + + public void updateEventTaskInstances(LinkedList newTasks) { + for (final Iterator it = newTasks.iterator(); it.hasNext();) { + final ITask task = it.next(); + if (!(task instanceof IEventTask)) { + final EventTaskInstancesListGenerator etlg = new EventTaskInstancesListGenerator(); + task.accept(etlg); + final LinkedList eventTaskInstances = etlg + .getEventlist(); + etisOfTasks.put(task.getId(), eventTaskInstances); + } + } } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/StaticTriangleMatrix.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/StaticTriangleMatrix.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/StaticTriangleMatrix.java (revision 1733) @@ -3,53 +3,65 @@ import java.io.Serializable; -public class StaticTriangleMatrix implements ITriangleMatrix,Serializable { - +public class StaticTriangleMatrix implements ITriangleMatrix, Serializable { + /** * */ private static final long serialVersionUID = 7599542322424894866L; - private float[] matrix; + private final float[] matrix; protected int size; - - + public StaticTriangleMatrix(int size) { this.size = size; - matrix = new float [size*(size+1)/2]; - } - - public float get(int first, int second) { - int row = Math.min(first, second); - int col = Math.max(first, second); - return matrix[row*size-(row*(row+1)/2 - (size-col))]; - - } - - public void set(int first, int second, float value) { - int row = Math.min(first, second); - int col = Math.max(first, second); - matrix[row*size-(row*(row+1)/2 - (size-col))] = value; + matrix = new float[(size * (size + 1)) / 2]; } + @Override + public float get(int first, int second) { + final int row = Math.min(first, second); + final int col = Math.max(first, second); + return matrix[(row * size) - (((row * (row + 1)) / 2) - (size - col))]; + + } + + @Override + public void increaseSize(int count) throws Exception { + throw new Exception( + "Cannot call this function on this implementation of ITriangle Matrix"); + + } + + @Override public void initialize(float value) { - for (int i=0; i < matrix.length; i++) { + for (int i = 0; i < matrix.length; i++) { matrix[i] = value; } } - - + @Override + public void set(int first, int second, float value) { + final int row = Math.min(first, second); + final int col = Math.max(first, second); + matrix[(row * size) - (((row * (row + 1)) / 2) - (size - col))] = value; + } + + @Override + public int size() { + return size; + } + + @Override public String toString() { String result = ""; for (int i = 0; i < size; i++) { - for(int j = 0; j< size; j++) { - if(i uniqueTasks); -public interface SubstitutionMatrix { - + public float getGapPenalty(); public float getScore(int pos1, int pos2); - public float getGapPenalty(); - - public void generate(HashSet uniqueTasks); - public void update(LinkedList newlyGeneratedTasks); - } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/UPGMAMatrix.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/UPGMAMatrix.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/alignment/matrix/UPGMAMatrix.java (revision 1733) @@ -1,5 +1,3 @@ package de.ugoe.cs.autoquest.tasktrees.alignment.matrix; - - public class UPGMAMatrix extends StaticTriangleMatrix { @@ -9,8 +7,10 @@ } + @Override public int size() { return size; } + @Override public String toString() { String result = ""; @@ -19,16 +19,15 @@ } result += "\n"; - + for (int i = 0; i < size; i++) { - for(int j = 0; j< size; j++) { - if(i - * The component manager is the central reference for the distinct submodules required for - * task tree generation. Such include the temporal relationship rule manager, the task equality - * rule manager, the default task builder, as well as the default task factory. + * The component manager is the central reference for the distinct submodules + * required for task tree generation. Such include the temporal relationship + * rule manager, the task equality rule manager, the default task builder, as + * well as the default task factory. *

* @@ -32,106 +33,106 @@ */ public class ComponentManager { - - /** - *

- * singleton instance of this class - *

- */ - private static ComponentManager instance; - /** - *

- * the default temporal relationship rule manager - *

- */ - private TemporalRelationshipRuleManager temporalRelationshipRuleManager; + /** + *

+ * clears the singleton instance. Needed for test purposes to ensure + * statelessness between tests. + *

+ */ + public static synchronized void clearInstance() { + instance = null; + } - /** - *

- * the default task builder - *

- */ - private ITaskBuilder taskBuilder; + /** + *

+ * returns the default task builder + *

+ * + * @return as described + */ + public static ITaskBuilder getDefaultTaskBuilder() { + return getInstance().taskBuilder; + } - /** - *

- * the default task factory - *

- */ - private ITaskFactory taskFactory; + /** + *

+ * returns the default task factory + *

+ * + * @return as described + */ + public static ITaskFactory getDefaultTaskFactory() { + return getInstance().taskFactory; + } - /** - *

- * returns the default temporal relationship rule manager - *

- * - * @return as described - */ - public static TemporalRelationshipRuleManager getTemporalRelationshipRuleManager() { - return getInstance().temporalRelationshipRuleManager; - } + /** + *

+ * returns the singleton instance of this class + *

+ * + * @return as described + */ + private static synchronized ComponentManager getInstance() { + if (instance == null) { + instance = new ComponentManager(); + instance.init(); + } + return instance; + } - /** - *

- * returns the default task builder - *

- * - * @return as described - */ - public static ITaskBuilder getDefaultTaskBuilder() { - return getInstance().taskBuilder; - } + /** + *

+ * returns the default temporal relationship rule manager + *

+ * + * @return as described + */ + public static TemporalRelationshipRuleManager getTemporalRelationshipRuleManager() { + return getInstance().temporalRelationshipRuleManager; + } - /** - *

- * returns the default task factory - *

- * - * @return as described - */ - public static ITaskFactory getDefaultTaskFactory() { - return getInstance().taskFactory; - } + /** + *

+ * singleton instance of this class + *

+ */ + private static ComponentManager instance; - /** - *

- * clears the singleton instance. Needed for test purposes to ensure statelessness between - * tests. - *

- */ - public static synchronized void clearInstance() { - instance = null; - } + /** + *

+ * the default temporal relationship rule manager + *

+ */ + private TemporalRelationshipRuleManager temporalRelationshipRuleManager; - /** - *

- * returns the singleton instance of this class - *

- * - * @return as described - */ - private static synchronized ComponentManager getInstance() { - if (instance == null) { - instance = new ComponentManager(); - instance.init(); - } - return instance; - } + /** + *

+ * the default task builder + *

+ */ + private ITaskBuilder taskBuilder; - /** - *

- * initialized the component manager with all it default components which are the temporal - * relationship rule manager, the task equality rule manager, the default task builder, as - * well as the default task factory. - *

- */ - private void init() { - taskBuilder = new TaskBuilder(); - taskFactory = new TaskFactory(); + /** + *

+ * the default task factory + *

+ */ + private ITaskFactory taskFactory; - temporalRelationshipRuleManager = - new TemporalRelationshipRuleManager(taskFactory, taskBuilder); - temporalRelationshipRuleManager.init(); - } + /** + *

+ * initialized the component manager with all it default components which + * are the temporal relationship rule manager, the task equality rule + * manager, the default task builder, as well as the default task factory. + *

+ */ + private void init() { + taskBuilder = new TaskBuilder(); + taskFactory = new TaskFactory(); + + temporalRelationshipRuleManager = new TemporalRelationshipRuleManager( + taskFactory, taskBuilder); + temporalRelationshipRuleManager.init(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/manager/TaskTreeManager.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/manager/TaskTreeManager.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/manager/TaskTreeManager.java (revision 1733) @@ -30,9 +30,10 @@ /** *

- * The task tree manager is responsible for transforming one or more user sessions into a task - * model. It can be called by providing a collection of user sessions where the result - * will be a task model. Furthermore, it can be used by providing single events in their respective - * order including notifications about where a user session ends. The result is a task model, - * as well. + * The task tree manager is responsible for transforming one or more user + * sessions into a task model. It can be called by providing a collection of + * user sessions where the result will be a task model. Furthermore, it can be + * used by providing single events in their respective order including + * notifications about where a user session ends. The result is a task model, as + * well. *

* @@ -41,134 +42,148 @@ */ public class TaskTreeManager { - - /** - *

- * the internally used task builder - *

- */ - private ITaskBuilder taskBuilder = ComponentManager.getDefaultTaskBuilder(); - /** - *

- * the internally used task factory - *

- */ - private ITaskFactory taskFactory = ComponentManager.getDefaultTaskFactory(); + /** + *

+ * the internally used task builder + *

+ */ + private final ITaskBuilder taskBuilder = ComponentManager + .getDefaultTaskBuilder(); - /** - *

- * if single events are provided, the user sessions collected so far - *

- */ - private List sessions = null; + /** + *

+ * the internally used task factory + *

+ */ + private final ITaskFactory taskFactory = ComponentManager + .getDefaultTaskFactory(); - /** - *

- * if single events are provided, the currently collected user session - *

- */ - private IUserSession currentSession = null; + /** + *

+ * if single events are provided, the user sessions collected so far + *

+ */ + private List sessions = null; - /** - *

- * initializes the task tree manager - *

- */ - public TaskTreeManager() { - sessions = new LinkedList(); - } + /** + *

+ * if single events are provided, the currently collected user session + *

+ */ + private IUserSession currentSession = null; - /** - *

- * creates a task model based on the provided user sessions. Yet, the user sessions are - * list of events. Such will be transformed in into task instances of event tasks assigned - * to {@link IUserSession}s. The {@link IUserSession}s will then be restructured using - * the temporal relationship rule manager to detect tasks and respective instances. The - * results of this transformation is stored in a task model which is the return value of - * this method. - *

- * - * @param newSessions the user sessions of which the task model shall be created - * - * @return the task model created from the user sessions - * - * @throws IllegalStateException if the task manager is already used by providing it with - * single events - */ - public synchronized ITaskModel createTaskModel(Collection> newSessions) { - if ((currentSession != null) || (sessions.size() > 0)) { - throw new IllegalStateException("do not mix calls to this method with calls to the " + - "other methods for handling tasks. Use only one " + - "variant instead."); - } - - for (List newSession : newSessions) { - if (newSession.size() > 0) { - for (Event event : newSession) { - handleNewEvent(event); - } - finishSession(); - } - } - - return getTaskModel(); - } + /** + *

+ * initializes the task tree manager + *

+ */ + public TaskTreeManager() { + sessions = new LinkedList(); + } - /** - *

- * handles a single event that occurred in a user session. - *

- * - * @param event the event to handle - */ - public void handleNewEvent(Event event) { - assertSessionSequence(); - String description = event.getType().getName() + " \u21D2 " + event.getTarget(); - IEventTask eventTask = taskFactory.createNewEventTask(description); - taskBuilder.addExecutedTask - (currentSession, taskFactory.createNewTaskInstance(eventTask, event)); - } + /** + *

+ * internally asserts that there is a current session to add new events to + *

+ */ + private void assertSessionSequence() { + if (currentSession == null) { + currentSession = taskFactory.createUserSession(); + } + } - /** - *

- * used to denote, that all previously added events using {@link #handleNewEvent(Event)} - * belong to the same session and that this session is now complete. All further events - * will be added to a new session which may be ended using this method, as well. - *

- */ - public void finishSession() { - if ((currentSession != null) && (currentSession.size() > 0)) { - sessions.add(currentSession); - currentSession = null; - } - } + /** + *

+ * creates a task model based on the provided user sessions. Yet, the user + * sessions are list of events. Such will be transformed in into task + * instances of event tasks assigned to {@link IUserSession}s. The + * {@link IUserSession}s will then be restructured using the temporal + * relationship rule manager to detect tasks and respective instances. The + * results of this transformation is stored in a task model which is the + * return value of this method. + *

+ * + * @param newSessions + * the user sessions of which the task model shall be created + * + * @return the task model created from the user sessions + * + * @throws IllegalStateException + * if the task manager is already used by providing it with + * single events + */ + public synchronized ITaskModel createTaskModel( + Collection> newSessions) { + if ((currentSession != null) || (sessions.size() > 0)) { + throw new IllegalStateException( + "do not mix calls to this method with calls to the " + + "other methods for handling tasks. Use only one " + + "variant instead."); + } - /** - *

- * returns the task model, that belongs to the events in the user sessions collected so far. - *

- * - * @return the task model - */ - public synchronized ITaskModel getTaskModel() { - finishSession(); - - Console.traceln(Level.INFO, "applying temporal relationship generation rules"); - - ComponentManager.getTemporalRelationshipRuleManager().applyRules(sessions); + for (final List newSession : newSessions) { + if (newSession.size() > 0) { + for (final Event event : newSession) { + handleNewEvent(event); + } + finishSession(); + } + } - return taskFactory.createTaskModel(sessions); - } + return getTaskModel(); + } - /** - *

- * internally asserts that there is a current session to add new events to - *

- */ - private void assertSessionSequence() { - if (currentSession == null) { - currentSession = taskFactory.createUserSession(); - } - } + /** + *

+ * used to denote, that all previously added events using + * {@link #handleNewEvent(Event)} belong to the same session and that this + * session is now complete. All further events will be added to a new + * session which may be ended using this method, as well. + *

+ */ + public void finishSession() { + if ((currentSession != null) && (currentSession.size() > 0)) { + sessions.add(currentSession); + currentSession = null; + } + } + + /** + *

+ * returns the task model, that belongs to the events in the user sessions + * collected so far. + *

+ * + * @return the task model + */ + public synchronized ITaskModel getTaskModel() { + finishSession(); + + Console.traceln(Level.INFO, + "applying temporal relationship generation rules"); + + ComponentManager.getTemporalRelationshipRuleManager().applyRules( + sessions); + + return taskFactory.createTaskModel(sessions); + } + + /** + *

+ * handles a single event that occurred in a user session. + *

+ * + * @param event + * the event to handle + */ + public void handleNewEvent(Event event) { + assertSessionSequence(); + final String description = event.getType().getName() + " \u21D2 " + + event.getTarget(); + final IEventTask eventTask = taskFactory + .createNewEventTask(description); + taskBuilder.addExecutedTask(currentSession, + taskFactory.createNewTaskInstance(eventTask, event)); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/EventTaskComparisonRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/EventTaskComparisonRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/EventTaskComparisonRule.java (revision 1733) @@ -24,6 +24,6 @@ /** *

- * This rule identifies two tasks as lexically equal, if they are both event tasks and - * if their respective event types and targets equal. + * This rule identifies two tasks as lexically equal, if they are both event + * tasks and if their respective event types and targets equal. *

* @@ -31,118 +31,142 @@ */ public class EventTaskComparisonRule implements TaskComparisonRule { - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITask, ITask) - */ - @Override - public boolean isApplicable(ITask task1, ITask task2) { - return (task1 instanceof IEventTask) && (task2 instanceof IEventTask); - } - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) - */ - @Override - public boolean areLexicallyEqual(ITask task1, ITask task2) { - Collection taskInstances1 = task1.getInstances(); - Collection taskInstances2 = task2.getInstances(); - - for (ITaskInstance instance1 : taskInstances1) { - boolean found = false; - - for (ITaskInstance instance2 : taskInstances2) { - if (areLexicallyEqual(instance1, instance2)) { - found = true; - break; - } - } - - if (!found) { - return false; - } - } - - return true; - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) + */ + @Override + public boolean areLexicallyEqual(ITask task1, ITask task2) { + final Collection taskInstances1 = task1.getInstances(); + final Collection taskInstances2 = task2.getInstances(); - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) - */ - @Override - public boolean areSyntacticallyEqual(ITask task1, ITask task2) { - return areLexicallyEqual(task1, task2); - } + for (final ITaskInstance instance1 : taskInstances1) { + boolean found = false; - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) - */ - @Override - public boolean areSemanticallyEqual(ITask task1, ITask task2) { - return areLexicallyEqual(task1, task2); - } + for (final ITaskInstance instance2 : taskInstances2) { + if (areLexicallyEqual(instance1, instance2)) { + found = true; + break; + } + } - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITask, ITask) - */ - @Override - public TaskEquality compare(ITask task1, ITask task2) { - if (areLexicallyEqual(task1, task2)) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return TaskEquality.UNEQUAL; - } - } + if (!found) { + return false; + } + } - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) - */ - @Override - public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { - return - (instance1 instanceof IEventTaskInstance) && (instance2 instanceof IEventTaskInstance); - } + return true; + } - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - IEventTaskInstance eventTask1 = (IEventTaskInstance) instance1; - IEventTaskInstance eventTask2 = (IEventTaskInstance) instance2; - - return (eventTask1.getEvent().getType().equals(eventTask2.getEvent().getType()) && - eventTask1.getEvent().getTarget().equals(eventTask2.getEvent().getTarget())); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) + */ + @Override + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final IEventTaskInstance eventTask1 = (IEventTaskInstance) instance1; + final IEventTaskInstance eventTask2 = (IEventTaskInstance) instance2; - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - return areLexicallyEqual(instance1, instance2); - } + return (eventTask1.getEvent().getType() + .equals(eventTask2.getEvent().getType()) && eventTask1 + .getEvent().getTarget() + .equals(eventTask2.getEvent().getTarget())); + } - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - return areLexicallyEqual(instance1, instance2); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) + */ + @Override + public boolean areSemanticallyEqual(ITask task1, ITask task2) { + return areLexicallyEqual(task1, task2); + } - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) - */ - @Override - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { - if (areLexicallyEqual(instance1, instance2)) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return TaskEquality.UNEQUAL; - } - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + return areLexicallyEqual(instance1, instance2); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) + */ + @Override + public boolean areSyntacticallyEqual(ITask task1, ITask task2) { + return areLexicallyEqual(task1, task2); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + return areLexicallyEqual(instance1, instance2); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITask, ITask) + */ + @Override + public TaskEquality compare(ITask task1, ITask task2) { + if (areLexicallyEqual(task1, task2)) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return TaskEquality.UNEQUAL; + } + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) + */ + @Override + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { + if (areLexicallyEqual(instance1, instance2)) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return TaskEquality.UNEQUAL; + } + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITask, ITask) + */ + @Override + public boolean isApplicable(ITask task1, ITask task2) { + return (task1 instanceof IEventTask) && (task2 instanceof IEventTask); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) + */ + @Override + public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { + return (instance1 instanceof IEventTaskInstance) + && (instance2 instanceof IEventTaskInstance); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/GUIEventTaskComparisonRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/GUIEventTaskComparisonRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/GUIEventTaskComparisonRule.java (revision 1733) @@ -50,11 +50,13 @@ *

* This rule compares GUI event tasks (i.e. it is more concrete, than the - * {@link EventTaskComparisonRule}). Two GUI event tasks are only equal if their event type and - * target are equal. The returned equality is even more fine-grained for events whose type is - * {@link TextInput} and {@link ValueSelection}. For text inputs, lexical equality is returned if - * the same text is entered using the same key interactions. Syntactical equality is returned if - * the same text is entered using different key interactions. Semantical equality is returned if - * different text is entered, but into the same event target. Value selections are syntactically - * equal, if the same value is selected. Otherwise they are semantically equal. + * {@link EventTaskComparisonRule}). Two GUI event tasks are only equal if their + * event type and target are equal. The returned equality is even more + * fine-grained for events whose type is {@link TextInput} and + * {@link ValueSelection}. For text inputs, lexical equality is returned if the + * same text is entered using the same key interactions. Syntactical equality is + * returned if the same text is entered using different key interactions. + * Semantical equality is returned if different text is entered, but into the + * same event target. Value selections are syntactically equal, if the same + * value is selected. Otherwise they are semantically equal. *

* @@ -62,560 +64,618 @@ */ public class GUIEventTaskComparisonRule implements TaskComparisonRule { - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITask, ITask) - */ - @Override - public boolean isApplicable(ITask task1, ITask task2) { - for (ITaskInstance instance : task1.getInstances()) { - if ((!(instance instanceof IEventTaskInstance)) || - (!(((IEventTaskInstance) instance).getEvent().getType() instanceof IInteraction))) - { - return false; - } - } - - for (ITaskInstance instance : task2.getInstances()) { - if ((!(instance instanceof IEventTaskInstance)) || - (!(((IEventTaskInstance) instance).getEvent().getType() instanceof IInteraction))) - { - return false; - } - } - - return true; - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) - */ - @Override - public boolean areLexicallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) - */ - @Override - public boolean areSyntacticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) - */ - @Override - public boolean areSemanticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITask, ITask) - */ - @Override - public TaskEquality compare(ITask task1, ITask task2) { - return getEquality(task1, task2, null); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule#isApplicable(de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) - */ - @Override - public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { - return - (instance1 instanceof IEventTaskInstance) && - (instance2 instanceof IEventTaskInstance) && - (((IEventTaskInstance) instance1).getEvent().getType() instanceof IInteraction) && - (((IEventTaskInstance) instance1).getEvent().getType() instanceof IInteraction); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule#areLexicallyEqual(de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) - */ - @Override - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule#areSyntacticallyEqual(de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) - */ - @Override - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule#areSemanticallyEqual(de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) - */ - @Override - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule#compare(de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) - */ - @Override - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { - return getEquality(instance1, instance2, null); - } - - /** - * - */ - private TaskEquality getEquality(ITask task1, - ITask task2, - TaskEquality requiredEqualityLevel) - { - Collection taskInstances1 = task1.getInstances(); - Collection taskInstances2 = task2.getInstances(); - - TaskEquality checkedEquality = - requiredEqualityLevel != null ? requiredEqualityLevel : TaskEquality.SEMANTICALLY_EQUAL; - - TaskEquality commonDenominator = TaskEquality.LEXICALLY_EQUAL; - - for (ITaskInstance instance1 : taskInstances1) { - TaskEquality mostConcreteEquality = null; - - for (ITaskInstance instance2 : taskInstances2) { - TaskEquality equality = getEquality(instance1, instance2, requiredEqualityLevel); - - if ((equality != null) && ((mostConcreteEquality == null) || - (equality.isAtLeast(mostConcreteEquality)))) - { - mostConcreteEquality = equality; - - if (((requiredEqualityLevel != null) && - (mostConcreteEquality.isAtLeast(requiredEqualityLevel))) || - (mostConcreteEquality.isAtLeast(TaskEquality.LEXICALLY_EQUAL))) - { - break; - } - } - } - - commonDenominator = commonDenominator.getCommonDenominator(mostConcreteEquality); - - if (!commonDenominator.isAtLeast(checkedEquality)) { - return TaskEquality.UNEQUAL; - } - } - - return commonDenominator; - } - - /** - * - */ - private TaskEquality getEquality(ITaskInstance instance1, - ITaskInstance instance2, - TaskEquality requiredEqualityLevel) - { - IEventTaskInstance eventTask1 = (IEventTaskInstance) instance1; - IEventTaskInstance eventTask2 = (IEventTaskInstance) instance2; - - if (!eventTask1.getEvent().getTarget().equals(eventTask2.getEvent().getTarget())) { - return TaskEquality.UNEQUAL; - } - - IInteraction interaction1 = (IInteraction) eventTask1.getEvent().getType(); - IInteraction interaction2 = (IInteraction) eventTask2.getEvent().getType(); - - return compareInteractions - (interaction1, interaction2, eventTask1.getEvent().getTarget(), requiredEqualityLevel); - } - - /** - *

- * compares two interactions. The method delegates to other, more specific compare method, e.g., - * {@link #compareTextInputs(TextInput, TextInput)} and - * {@link #compareValueSelections(ValueSelection, ValueSelection)}, if any exist for the - * concrete interaction types. Otherwise it uses the equals method of the interactions for - * comparison. In this case, if the interactions equals method returns true, this method - * returns lexical equality. - *

- *

- * The provided equality level can be used to restrict the quality check to the given level. - * This is done for optimization purposes. The returned equality level can be at most as - * concrete as the provided one. If the provided one is null, it is expected to be lexical - * equality. - *

- * - * @param interaction1 the first interaction to compare - * @param interaction2 the second interaction to compare - * @param eventTarget the event target on which the interactions happened (used within - * special comparisons like mouse clicks on buttons, where the coordinates - * can be ignored) - * @param equalityLevel the equality level to be checked for - * - * @return as described - */ - private TaskEquality compareInteractions(IInteraction interaction1, - IInteraction interaction2, - IEventTarget eventTarget, - TaskEquality equalityLevel) - { - TaskEquality level = equalityLevel; - - if (level == null) { - level = TaskEquality.LEXICALLY_EQUAL; - } - - if (interaction1 == interaction2) { - return TaskEquality.LEXICALLY_EQUAL; - } - else if ((interaction1 instanceof KeyInteraction) && - (interaction2 instanceof KeyInteraction)) - { - return compareKeyInteractions - ((KeyInteraction) interaction1, (KeyInteraction) interaction2, level); - } - else if ((interaction1 instanceof MouseButtonInteraction) && - (interaction2 instanceof MouseButtonInteraction)) - { - return compareMouseButtonInteractions - ((MouseButtonInteraction) interaction1, (MouseButtonInteraction) interaction2, - eventTarget, level); - } - else if ((interaction1 instanceof Scroll) && (interaction2 instanceof Scroll)) { - return compareScrolls((Scroll) interaction1, (Scroll) interaction2, level); - } - else if ((interaction1 instanceof TextInput) && (interaction2 instanceof TextInput)) { - return compareTextInputs - ((TextInput) interaction1, (TextInput) interaction2, level); - } - else if ((interaction1 instanceof ValueSelection) && - (interaction2 instanceof ValueSelection)) - { - return compareValueSelections - ((ValueSelection) interaction1, (ValueSelection) interaction2, level); - } - else if (interaction1.equals(interaction2)) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return TaskEquality.UNEQUAL; - } - } - - /** - *

- * compares two key interactions. If both are of the same type and if both have the - * same key, they are lexically equal. If both are only of the same type, they are - * semantically equal. Otherwise, they are unequal. - *

- *

- * The provided equality level can be used to restrict the quality check to the given level. - * This is done for optimization purposes. The returned equality level is as concrete as - * the provided one. It may be more concrete if there is no difference regarding the - * comparison on the levels. - *

- * - * @param interaction1 the first key interaction - * @param interaction2 the second key interaction - * @param equalityLevel the equality level to be checked for - * - * @return as described - */ - private TaskEquality compareKeyInteractions(KeyInteraction interaction1, - KeyInteraction interaction2, - TaskEquality equalityLevel) - { - if (((interaction1 instanceof KeyPressed) && (interaction2 instanceof KeyPressed)) || - ((interaction1 instanceof KeyReleased) && (interaction2 instanceof KeyReleased)) || - ((interaction1 instanceof KeyTyped) && (interaction2 instanceof KeyTyped))) - { - if ((equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)) && - (interaction1.getKey() == interaction2.getKey())) - { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return TaskEquality.SEMANTICALLY_EQUAL; - } - } - - return TaskEquality.UNEQUAL; - } - - /** - *

- * compares two mouse drag and drops. If both drag and drops have the same start and end - * coordinates, they are lexically equal. Otherwise, they are semantically equal. - *

- *

- * The provided equality level can be used to restrict the quality check to the given level. - * This is done for optimization purposes. The returned equality level is as concrete as - * the provided one. It may be more concrete if there is no difference regarding the - * comparison on the levels. - *

- * - * @param interaction1 the first mouse drag and drop to compare - * @param interaction2 the second mouse drag and drop to compare - * @param equalityLevel the equality level to be checked for - * - * @return as described - */ - private TaskEquality compareMouseDragAndDrops(MouseDragAndDrop interaction1, - MouseDragAndDrop interaction2, - TaskEquality equalityLevel) - { - if (interaction1.getButton() != interaction2.getButton()) { - return TaskEquality.UNEQUAL; - } - - if (equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)) { - int x1 = interaction1.getX(); - int x1Start = interaction1.getXStart(); - int x2 = interaction2.getX(); - int x2Start = interaction2.getXStart(); - int y1 = interaction1.getY(); - int y1Start = interaction1.getYStart(); - int y2 = interaction2.getY(); - int y2Start = interaction2.getYStart(); - - if ((x1Start == x2Start) && (x1 == x2) && (y1Start == y2Start) && (y1 == y2)) { - return TaskEquality.LEXICALLY_EQUAL; - } - } - - return TaskEquality.SEMANTICALLY_EQUAL; - } - - /** - *

- * compares two mouse button interactions such as clicks, mouse button down, or double clicks. - * If both interactions have the same coordinates, they are lexically equal. Otherwise, they - * are semantically equal. Mouse clicks for which the coordinates make no lexical difference - * (see {@link #clickCoordinatesMakeLexicalDifference(IEventTarget)}) are treated as - * lexically equal. - *

- *

- * The provided equality level can be used to restrict the quality check to the given level. - * This is done for optimization purposes. The returned equality level is as concrete as - * the provided one. It may be more concrete if there is no difference regarding the - * comparison on the levels. - *

- * - * @param interaction1 the first mouse button interaction to compare - * @param interaction2 the second mouse button interaction to compare - * @param eventTarget the event target on which the interactions happened (used within - * special comparisons like mouse clicks on buttons, where the coordinates - * can be ignored) - * @param equalityLevel the equality level to be checked for - * - * @return as described - */ - private TaskEquality compareMouseButtonInteractions(MouseButtonInteraction interaction1, - MouseButtonInteraction interaction2, - IEventTarget eventTarget, - TaskEquality equalityLevel) - { - boolean coordinatesMatch = true; - - if ((interaction1 instanceof MouseDragAndDrop) && - (interaction2 instanceof MouseDragAndDrop)) - { - return compareMouseDragAndDrops - ((MouseDragAndDrop) interaction1, (MouseDragAndDrop) interaction2, equalityLevel); - } - else if (interaction1.getButton() != interaction2.getButton()) { - return TaskEquality.UNEQUAL; - } - else if (equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL) && - clickCoordinatesMakeLexicalDifference(eventTarget)) - { - int x1 = interaction1.getX(); - int x2 = interaction2.getX(); - int y1 = interaction1.getY(); - int y2 = interaction2.getY(); - - if ((x1 != x2) || (y1 != y2)) { - coordinatesMatch = false; - } - } - - // up to now, they can be equal. Now check the types. Do it as last action as these - // checks take the most time and should, therefore, only be done latest - if (((interaction1 instanceof MouseClick) && (interaction2 instanceof MouseClick)) || - ((interaction1 instanceof MouseDoubleClick) && - (interaction2 instanceof MouseDoubleClick)) || - ((interaction1 instanceof MouseButtonDown) && - (interaction2 instanceof MouseButtonDown)) || - ((interaction1 instanceof MouseButtonUp) && - (interaction2 instanceof MouseButtonUp))) - { - if (coordinatesMatch) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return TaskEquality.SEMANTICALLY_EQUAL; - } - } - - return TaskEquality.UNEQUAL; - } - - /** - *

- * compares two mouse button interactions such as clicks, mouse button down, or double clicks. - * If both interactions have the same coordinates, they are lexically equal. Otherwise, they - * are semantically equal. Mouse clicks for which the coordinates make no lexical difference - * (see {@link #clickCoordinatesMakeLexicalDifference(IEventTarget)}) are treated as - * lexically equal. - *

- *

- * The provided equality level can be used to restrict the quality check to the given level. - * This is done for optimization purposes. The returned equality level is as concrete as - * the provided one. It may be more concrete if there is no difference regarding the - * comparison on the levels. - *

- * - * @param interaction1 the first mouse button interaction to compare - * @param interaction2 the second mouse button interaction to compare - * @param eventTarget the event target on which the interactions happened (used within - * special comparisons like mouse clicks on buttons, where the coordinates - * can be ignored) - * @param equalityLevel the equality level to be checked for - * - * @return as described - */ - private TaskEquality compareScrolls(Scroll interaction1, - Scroll interaction2, - TaskEquality equalityLevel) - { - if (equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)) { - int x1 = interaction1.getXPosition(); - int x2 = interaction2.getXPosition(); - int y1 = interaction1.getYPosition(); - int y2 = interaction2.getYPosition(); - - if ((x1 == x2) && (y1 == y2)) { - return TaskEquality.LEXICALLY_EQUAL; - } - } - - return TaskEquality.SEMANTICALLY_EQUAL; - } - - /** - *

- * compares two text inputs. If both text inputs have the same entered text and text input - * events, they are lexically equal. If they only have the same entered text, they are - * syntactically equal. If they are only both text inputs, they are semantically equal. - * (the equality of the event targets is checked beforehand). - *

- *

- * The provided equality level can be used to restrict the quality check to the given level. - * This is done for optimization purposes. The returned equality level is as concrete as - * the provided one. It may be more concrete if there is no difference regarding the - * comparison on the levels. - *

- * - * @param interaction1 the first text input to compare - * @param interaction2 the second text input to compare - * @param equalityLevel the equality level to be checked for - * - * @return as described - */ - private TaskEquality compareTextInputs(TextInput interaction1, - TextInput interaction2, - TaskEquality equalityLevel) - { - switch (equalityLevel) { - case LEXICALLY_EQUAL: - if (interaction1.getTextInputEvents().equals(interaction2.getTextInputEvents())) { - return TaskEquality.LEXICALLY_EQUAL; - } - // fall through - case SYNTACTICALLY_EQUAL: - if (interaction1.getEnteredText().equals(interaction2.getEnteredText())) { - return TaskEquality.SYNTACTICALLY_EQUAL; - } - // fall through - case SEMANTICALLY_EQUAL: - return TaskEquality.SEMANTICALLY_EQUAL; - default: - return TaskEquality.UNEQUAL; - } - } - - /** - *

- * compares two value selections. If both value selections have the same selected value, they - * are syntactically equal, otherwise they are semantically equal. - * (the equality of the event targets is checked beforehand). - *

- *

- * The provided equality level can be used to restrict the quality check to the given level. - * This is done for optimization purposes. The returned equality level is as concrete as - * the provided one. It may be more concrete if there is no difference regarding the - * comparison on the levels. - *

- * - * @param interaction1 the first value selection to compare - * @param interaction2 the second value selection to compare - * @param equalityLevel the equality level to be checked for - * - * @return as described - */ - private TaskEquality compareValueSelections(ValueSelection interaction1, - ValueSelection interaction2, - TaskEquality equalityLevel) - { - if (equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)) { - Object value1 = interaction1.getSelectedValue(); - Object value2 = interaction2.getSelectedValue(); - - if ((value1 == value2) || ((value1 != null) && (value1.equals(value2)))) { - return TaskEquality.LEXICALLY_EQUAL; - } - } - - return TaskEquality.SEMANTICALLY_EQUAL; - } - - /** - *

- * Checks, if the coordinates of a click or double click on the provided event target makes - * a lexical difference. Mouse clicks and double clicks on buttons, check boxes, - * combo boxes, images, list boxes, menu buttons, radio buttons, shapes, uneditable text, - * and tool tips have no lexical difference as long as they happen on the same event target. - * The concrete coordinates are not relevant. - *

- * - * @param eventTarget the event target on which the interaction occurred - * - * @return if the coordinates are important to be considered for clicks and double clicks, - * false else - */ - private boolean clickCoordinatesMakeLexicalDifference(IEventTarget eventTarget) { - if ((eventTarget instanceof IButton) || - (eventTarget instanceof ICheckBox) || - (eventTarget instanceof IComboBox) || - (eventTarget instanceof IImage) || - (eventTarget instanceof IListBox) || - (eventTarget instanceof IMenu) || - (eventTarget instanceof IMenuButton) || - (eventTarget instanceof IRadioButton) || - (eventTarget instanceof IShape) || - (eventTarget instanceof IText) || - (eventTarget instanceof IToolTip)) - { - return false; - } - else { - return true; - } - } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) + */ + @Override + public boolean areLexicallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule# + * areLexicallyEqual(de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) + */ + @Override + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) + */ + @Override + public boolean areSemanticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule# + * areSemanticallyEqual + * (de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) + */ + @Override + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) + */ + @Override + public boolean areSyntacticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule# + * areSyntacticallyEqual + * (de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) + */ + @Override + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /** + *

+ * Checks, if the coordinates of a click or double click on the provided + * event target makes a lexical difference. Mouse clicks and double clicks + * on buttons, check boxes, combo boxes, images, list boxes, menu buttons, + * radio buttons, shapes, uneditable text, and tool tips have no lexical + * difference as long as they happen on the same event target. The concrete + * coordinates are not relevant. + *

+ * + * @param eventTarget + * the event target on which the interaction occurred + * + * @return if the coordinates are important to be considered for clicks and + * double clicks, false else + */ + private boolean clickCoordinatesMakeLexicalDifference( + IEventTarget eventTarget) { + if ((eventTarget instanceof IButton) + || (eventTarget instanceof ICheckBox) + || (eventTarget instanceof IComboBox) + || (eventTarget instanceof IImage) + || (eventTarget instanceof IListBox) + || (eventTarget instanceof IMenu) + || (eventTarget instanceof IMenuButton) + || (eventTarget instanceof IRadioButton) + || (eventTarget instanceof IShape) + || (eventTarget instanceof IText) + || (eventTarget instanceof IToolTip)) { + return false; + } else { + return true; + } + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITask, ITask) + */ + @Override + public TaskEquality compare(ITask task1, ITask task2) { + return getEquality(task1, task2, null); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule#compare + * (de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) + */ + @Override + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { + return getEquality(instance1, instance2, null); + } + + /** + *

+ * compares two interactions. The method delegates to other, more specific + * compare method, e.g., {@link #compareTextInputs(TextInput, TextInput)} + * and {@link #compareValueSelections(ValueSelection, ValueSelection)}, if + * any exist for the concrete interaction types. Otherwise it uses the + * equals method of the interactions for comparison. In this case, if the + * interactions equals method returns true, this method returns lexical + * equality. + *

+ *

+ * The provided equality level can be used to restrict the quality check to + * the given level. This is done for optimization purposes. The returned + * equality level can be at most as concrete as the provided one. If the + * provided one is null, it is expected to be lexical equality. + *

+ * + * @param interaction1 + * the first interaction to compare + * @param interaction2 + * the second interaction to compare + * @param eventTarget + * the event target on which the interactions happened (used + * within special comparisons like mouse clicks on buttons, where + * the coordinates can be ignored) + * @param equalityLevel + * the equality level to be checked for + * + * @return as described + */ + private TaskEquality compareInteractions(IInteraction interaction1, + IInteraction interaction2, IEventTarget eventTarget, + TaskEquality equalityLevel) { + TaskEquality level = equalityLevel; + + if (level == null) { + level = TaskEquality.LEXICALLY_EQUAL; + } + + if (interaction1 == interaction2) { + return TaskEquality.LEXICALLY_EQUAL; + } else if ((interaction1 instanceof KeyInteraction) + && (interaction2 instanceof KeyInteraction)) { + return compareKeyInteractions((KeyInteraction) interaction1, + (KeyInteraction) interaction2, level); + } else if ((interaction1 instanceof MouseButtonInteraction) + && (interaction2 instanceof MouseButtonInteraction)) { + return compareMouseButtonInteractions( + (MouseButtonInteraction) interaction1, + (MouseButtonInteraction) interaction2, eventTarget, level); + } else if ((interaction1 instanceof Scroll) + && (interaction2 instanceof Scroll)) { + return compareScrolls((Scroll) interaction1, (Scroll) interaction2, + level); + } else if ((interaction1 instanceof TextInput) + && (interaction2 instanceof TextInput)) { + return compareTextInputs((TextInput) interaction1, + (TextInput) interaction2, level); + } else if ((interaction1 instanceof ValueSelection) + && (interaction2 instanceof ValueSelection)) { + return compareValueSelections((ValueSelection) interaction1, + (ValueSelection) interaction2, level); + } else if (interaction1.equals(interaction2)) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return TaskEquality.UNEQUAL; + } + } + + /** + *

+ * compares two key interactions. If both are of the same type and if both + * have the same key, they are lexically equal. If both are only of the same + * type, they are semantically equal. Otherwise, they are unequal. + *

+ *

+ * The provided equality level can be used to restrict the quality check to + * the given level. This is done for optimization purposes. The returned + * equality level is as concrete as the provided one. It may be more + * concrete if there is no difference regarding the comparison on the + * levels. + *

+ * + * @param interaction1 + * the first key interaction + * @param interaction2 + * the second key interaction + * @param equalityLevel + * the equality level to be checked for + * + * @return as described + */ + private TaskEquality compareKeyInteractions(KeyInteraction interaction1, + KeyInteraction interaction2, TaskEquality equalityLevel) { + if (((interaction1 instanceof KeyPressed) && (interaction2 instanceof KeyPressed)) + || ((interaction1 instanceof KeyReleased) && (interaction2 instanceof KeyReleased)) + || ((interaction1 instanceof KeyTyped) && (interaction2 instanceof KeyTyped))) { + if ((equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)) + && (interaction1.getKey() == interaction2.getKey())) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return TaskEquality.SEMANTICALLY_EQUAL; + } + } + + return TaskEquality.UNEQUAL; + } + + /** + *

+ * compares two mouse button interactions such as clicks, mouse button down, + * or double clicks. If both interactions have the same coordinates, they + * are lexically equal. Otherwise, they are semantically equal. Mouse clicks + * for which the coordinates make no lexical difference (see + * {@link #clickCoordinatesMakeLexicalDifference(IEventTarget)}) are treated + * as lexically equal. + *

+ *

+ * The provided equality level can be used to restrict the quality check to + * the given level. This is done for optimization purposes. The returned + * equality level is as concrete as the provided one. It may be more + * concrete if there is no difference regarding the comparison on the + * levels. + *

+ * + * @param interaction1 + * the first mouse button interaction to compare + * @param interaction2 + * the second mouse button interaction to compare + * @param eventTarget + * the event target on which the interactions happened (used + * within special comparisons like mouse clicks on buttons, where + * the coordinates can be ignored) + * @param equalityLevel + * the equality level to be checked for + * + * @return as described + */ + private TaskEquality compareMouseButtonInteractions( + MouseButtonInteraction interaction1, + MouseButtonInteraction interaction2, IEventTarget eventTarget, + TaskEquality equalityLevel) { + boolean coordinatesMatch = true; + + if ((interaction1 instanceof MouseDragAndDrop) + && (interaction2 instanceof MouseDragAndDrop)) { + return compareMouseDragAndDrops((MouseDragAndDrop) interaction1, + (MouseDragAndDrop) interaction2, equalityLevel); + } else if (interaction1.getButton() != interaction2.getButton()) { + return TaskEquality.UNEQUAL; + } else if (equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL) + && clickCoordinatesMakeLexicalDifference(eventTarget)) { + final int x1 = interaction1.getX(); + final int x2 = interaction2.getX(); + final int y1 = interaction1.getY(); + final int y2 = interaction2.getY(); + + if ((x1 != x2) || (y1 != y2)) { + coordinatesMatch = false; + } + } + + // up to now, they can be equal. Now check the types. Do it as last + // action as these + // checks take the most time and should, therefore, only be done latest + if (((interaction1 instanceof MouseClick) && (interaction2 instanceof MouseClick)) + || ((interaction1 instanceof MouseDoubleClick) && (interaction2 instanceof MouseDoubleClick)) + || ((interaction1 instanceof MouseButtonDown) && (interaction2 instanceof MouseButtonDown)) + || ((interaction1 instanceof MouseButtonUp) && (interaction2 instanceof MouseButtonUp))) { + if (coordinatesMatch) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return TaskEquality.SEMANTICALLY_EQUAL; + } + } + + return TaskEquality.UNEQUAL; + } + + /** + *

+ * compares two mouse drag and drops. If both drag and drops have the same + * start and end coordinates, they are lexically equal. Otherwise, they are + * semantically equal. + *

+ *

+ * The provided equality level can be used to restrict the quality check to + * the given level. This is done for optimization purposes. The returned + * equality level is as concrete as the provided one. It may be more + * concrete if there is no difference regarding the comparison on the + * levels. + *

+ * + * @param interaction1 + * the first mouse drag and drop to compare + * @param interaction2 + * the second mouse drag and drop to compare + * @param equalityLevel + * the equality level to be checked for + * + * @return as described + */ + private TaskEquality compareMouseDragAndDrops( + MouseDragAndDrop interaction1, MouseDragAndDrop interaction2, + TaskEquality equalityLevel) { + if (interaction1.getButton() != interaction2.getButton()) { + return TaskEquality.UNEQUAL; + } + + if (equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)) { + final int x1 = interaction1.getX(); + final int x1Start = interaction1.getXStart(); + final int x2 = interaction2.getX(); + final int x2Start = interaction2.getXStart(); + final int y1 = interaction1.getY(); + final int y1Start = interaction1.getYStart(); + final int y2 = interaction2.getY(); + final int y2Start = interaction2.getYStart(); + + if ((x1Start == x2Start) && (x1 == x2) && (y1Start == y2Start) + && (y1 == y2)) { + return TaskEquality.LEXICALLY_EQUAL; + } + } + + return TaskEquality.SEMANTICALLY_EQUAL; + } + + /** + *

+ * compares two mouse button interactions such as clicks, mouse button down, + * or double clicks. If both interactions have the same coordinates, they + * are lexically equal. Otherwise, they are semantically equal. Mouse clicks + * for which the coordinates make no lexical difference (see + * {@link #clickCoordinatesMakeLexicalDifference(IEventTarget)}) are treated + * as lexically equal. + *

+ *

+ * The provided equality level can be used to restrict the quality check to + * the given level. This is done for optimization purposes. The returned + * equality level is as concrete as the provided one. It may be more + * concrete if there is no difference regarding the comparison on the + * levels. + *

+ * + * @param interaction1 + * the first mouse button interaction to compare + * @param interaction2 + * the second mouse button interaction to compare + * @param eventTarget + * the event target on which the interactions happened (used + * within special comparisons like mouse clicks on buttons, where + * the coordinates can be ignored) + * @param equalityLevel + * the equality level to be checked for + * + * @return as described + */ + private TaskEquality compareScrolls(Scroll interaction1, + Scroll interaction2, TaskEquality equalityLevel) { + if (equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)) { + final int x1 = interaction1.getXPosition(); + final int x2 = interaction2.getXPosition(); + final int y1 = interaction1.getYPosition(); + final int y2 = interaction2.getYPosition(); + + if ((x1 == x2) && (y1 == y2)) { + return TaskEquality.LEXICALLY_EQUAL; + } + } + + return TaskEquality.SEMANTICALLY_EQUAL; + } + + /** + *

+ * compares two text inputs. If both text inputs have the same entered text + * and text input events, they are lexically equal. If they only have the + * same entered text, they are syntactically equal. If they are only both + * text inputs, they are semantically equal. (the equality of the event + * targets is checked beforehand). + *

+ *

+ * The provided equality level can be used to restrict the quality check to + * the given level. This is done for optimization purposes. The returned + * equality level is as concrete as the provided one. It may be more + * concrete if there is no difference regarding the comparison on the + * levels. + *

+ * + * @param interaction1 + * the first text input to compare + * @param interaction2 + * the second text input to compare + * @param equalityLevel + * the equality level to be checked for + * + * @return as described + */ + private TaskEquality compareTextInputs(TextInput interaction1, + TextInput interaction2, TaskEquality equalityLevel) { + switch (equalityLevel) { + case LEXICALLY_EQUAL: + if (interaction1.getTextInputEvents().equals( + interaction2.getTextInputEvents())) { + return TaskEquality.LEXICALLY_EQUAL; + } + // fall through + case SYNTACTICALLY_EQUAL: + if (interaction1.getEnteredText().equals( + interaction2.getEnteredText())) { + return TaskEquality.SYNTACTICALLY_EQUAL; + } + // fall through + case SEMANTICALLY_EQUAL: + return TaskEquality.SEMANTICALLY_EQUAL; + default: + return TaskEquality.UNEQUAL; + } + } + + /** + *

+ * compares two value selections. If both value selections have the same + * selected value, they are syntactically equal, otherwise they are + * semantically equal. (the equality of the event targets is checked + * beforehand). + *

+ *

+ * The provided equality level can be used to restrict the quality check to + * the given level. This is done for optimization purposes. The returned + * equality level is as concrete as the provided one. It may be more + * concrete if there is no difference regarding the comparison on the + * levels. + *

+ * + * @param interaction1 + * the first value selection to compare + * @param interaction2 + * the second value selection to compare + * @param equalityLevel + * the equality level to be checked for + * + * @return as described + */ + private TaskEquality compareValueSelections(ValueSelection interaction1, + ValueSelection interaction2, TaskEquality equalityLevel) { + if (equalityLevel.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)) { + final Object value1 = interaction1.getSelectedValue(); + final Object value2 = interaction2.getSelectedValue(); + + if ((value1 == value2) + || ((value1 != null) && (value1.equals(value2)))) { + return TaskEquality.LEXICALLY_EQUAL; + } + } + + return TaskEquality.SEMANTICALLY_EQUAL; + } + + /** + * + */ + private TaskEquality getEquality(ITask task1, ITask task2, + TaskEquality requiredEqualityLevel) { + final Collection taskInstances1 = task1.getInstances(); + final Collection taskInstances2 = task2.getInstances(); + + final TaskEquality checkedEquality = requiredEqualityLevel != null ? requiredEqualityLevel + : TaskEquality.SEMANTICALLY_EQUAL; + + TaskEquality commonDenominator = TaskEquality.LEXICALLY_EQUAL; + + for (final ITaskInstance instance1 : taskInstances1) { + TaskEquality mostConcreteEquality = null; + + for (final ITaskInstance instance2 : taskInstances2) { + final TaskEquality equality = getEquality(instance1, instance2, + requiredEqualityLevel); + + if ((equality != null) + && ((mostConcreteEquality == null) || (equality + .isAtLeast(mostConcreteEquality)))) { + mostConcreteEquality = equality; + + if (((requiredEqualityLevel != null) && (mostConcreteEquality + .isAtLeast(requiredEqualityLevel))) + || (mostConcreteEquality + .isAtLeast(TaskEquality.LEXICALLY_EQUAL))) { + break; + } + } + } + + commonDenominator = commonDenominator + .getCommonDenominator(mostConcreteEquality); + + if (!commonDenominator.isAtLeast(checkedEquality)) { + return TaskEquality.UNEQUAL; + } + } + + return commonDenominator; + } + + /** + * + */ + private TaskEquality getEquality(ITaskInstance instance1, + ITaskInstance instance2, TaskEquality requiredEqualityLevel) { + final IEventTaskInstance eventTask1 = (IEventTaskInstance) instance1; + final IEventTaskInstance eventTask2 = (IEventTaskInstance) instance2; + + if (!eventTask1.getEvent().getTarget() + .equals(eventTask2.getEvent().getTarget())) { + return TaskEquality.UNEQUAL; + } + + final IInteraction interaction1 = (IInteraction) eventTask1.getEvent() + .getType(); + final IInteraction interaction2 = (IInteraction) eventTask2.getEvent() + .getType(); + + return compareInteractions(interaction1, interaction2, eventTask1 + .getEvent().getTarget(), requiredEqualityLevel); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITask, ITask) + */ + @Override + public boolean isApplicable(ITask task1, ITask task2) { + for (final ITaskInstance instance : task1.getInstances()) { + if ((!(instance instanceof IEventTaskInstance)) + || (!(((IEventTaskInstance) instance).getEvent().getType() instanceof IInteraction))) { + return false; + } + } + + for (final ITaskInstance instance : task2.getInstances()) { + if ((!(instance instanceof IEventTaskInstance)) + || (!(((IEventTaskInstance) instance).getEvent().getType() instanceof IInteraction))) { + return false; + } + } + + return true; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.taskequality.TaskComparisonRule#isApplicable + * (de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance, + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance) + */ + @Override + public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { + return (instance1 instanceof IEventTaskInstance) + && (instance2 instanceof IEventTaskInstance) + && (((IEventTaskInstance) instance1).getEvent().getType() instanceof IInteraction) + && (((IEventTaskInstance) instance1).getEvent().getType() instanceof IInteraction); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/IterationComparisonRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/IterationComparisonRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/IterationComparisonRule.java (revision 1733) @@ -23,55 +23,59 @@ /** *

- * This class is capable of comparing Iterations. Iterations equal at distinct levels - * in distinct situations. The following table shows the results of the comparison for the - * specific situations (the parameters are commutative). In any other situation, the comparison - * returns NodeEquality.UNEQUAL: + * This class is capable of comparing Iterations. Iterations equal at distinct + * levels in distinct situations. The following table shows the results of the + * comparison for the specific situations (the parameters are commutative). In + * any other situation, the comparison returns NodeEquality.UNEQUAL + * : *

* * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * *
iteration 1iteration 2comparison result
any iterationany iteration with a child that is lexically equal to the child of iteration 1NodeEquality.LEXICALLY_EQUAL
any iterationany iteration with a child that is syntactically equal to the child of iteration 1NodeEquality.SYNTACTICALLY_EQUAL
any iterationany iteration with a child that is semantically equal to the child of iteration 1NodeEquality.SEMANTICALLY_EQUAL
an iteration with a selection of syntactically equal childrenan iteration with a child that is syntactically equal to the children of the child - * selection of iteration 1NodeEquality.SYNTACTICALLY_EQUAL
an iteration with a selection of syntactically equal childrenan iteration with a selection of syntactically equal children that are all syntactically - * equal to the selection of children of iteration 1NodeEquality.SYNTACTICALLY_EQUAL
an iteration with a selection of semantically equal childrenan iteration with a child that is semantically equal to the children of the child - * selection of iteration 1NodeEquality.SEMANTICALLY_EQUAL
an iteration with a selection of semantically equal childrenan iteration with a selection of semantically equal children that are all semantically - * equal to the selection of children of iteration 1NodeEquality.SEMANTICALLY_EQUAL
iteration 1iteration 2comparison result
any iterationany iteration with a child that is lexically equal to the child of + * iteration 1NodeEquality.LEXICALLY_EQUAL
any iterationany iteration with a child that is syntactically equal to the child of + * iteration 1NodeEquality.SYNTACTICALLY_EQUAL
any iterationany iteration with a child that is semantically equal to the child of + * iteration 1NodeEquality.SEMANTICALLY_EQUAL
an iteration with a selection of syntactically equal childrenan iteration with a child that is syntactically equal to the children of + * the child selection of iteration 1NodeEquality.SYNTACTICALLY_EQUAL
an iteration with a selection of syntactically equal childrenan iteration with a selection of syntactically equal children that are + * all syntactically equal to the selection of children of iteration 1NodeEquality.SYNTACTICALLY_EQUAL
an iteration with a selection of semantically equal childrenan iteration with a child that is semantically equal to the children of + * the child selection of iteration 1NodeEquality.SEMANTICALLY_EQUAL
an iteration with a selection of semantically equal childrenan iteration with a selection of semantically equal children that are all + * semantically equal to the selection of children of iteration 1NodeEquality.SEMANTICALLY_EQUAL
* @@ -80,307 +84,343 @@ */ public class IterationComparisonRule implements TaskComparisonRule { - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITask, ITask) - */ - @Override - public boolean isApplicable(ITask task1, ITask task2) { - return (task1 instanceof IIteration) && (task2 instanceof IIteration); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) - */ - @Override - public boolean areLexicallyEqual(ITask task1, ITask task2) { - ITask child1 = ((IIteration) task1).getMarkedTask(); - ITask child2 = ((IIteration) task2).getMarkedTask(); - - if (child1 != null) { - if (child2 == null) { - return false; - } - else { - // iterations may have 3 different structures. - // 1. they have one child, which is the iterated one - // 2. they have a sequence of children, which is iterated - // 3. they have a selection of different iterated variants (usually the variants - // are semantically equal) - // ignore the type of the children but check them for equality. - - return getNodeEquality(child1, child2).isAtLeast(TaskEquality.LEXICALLY_EQUAL); - } - } - else if (child2 == null) { - return true; - } - - return false; - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) - */ - @Override - public boolean areSyntacticallyEqual(ITask task1, ITask task2) { - return areLexicallyEqual(task1, task2); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) - */ - @Override - public boolean areSemanticallyEqual(ITask task1, ITask task2) { - return compare(task1, task2).isAtLeast(TaskEquality.SEMANTICALLY_EQUAL); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITask, ITask) - */ - @Override - public TaskEquality compare(ITask task1, ITask task2) { - ITask child1 = ((IIteration) task1).getMarkedTask(); - ITask child2 = ((IIteration) task2).getMarkedTask(); - - // if both iterations do not have children, they are equal although this doesn't make sense - if ((child1 == null) && (child2 == null)) { - return TaskEquality.LEXICALLY_EQUAL; - } - else if ((child1 == null) || (child2 == null)) { - return TaskEquality.UNEQUAL; - } - - // iterations may have 3 different structures. - // 1. they have one child, which is the iterated one - // 2. they have a sequence of children, which is iterated - // 3. they have a selection of different iterated variants (usually the variants are - // semantically equal) - // - // the permutations of the three variants in combination must be checked - - // check if both tasks are the same variants of iterations and if their children are equal. - // This condition matches, if both iterations are the same variants of iteration. I.e. three - // combinations of the permutation are handled herewith. - TaskEquality taskEquality = getNodeEquality(child1, child2); - - if (taskEquality != null) { - return taskEquality; - } - - // compare one iteration with a single task as a child and another one with a selection of - // semantically equal tasks - return selectionChildrenSemanticallyEqualNode(child1, child2); - - // all other combinations (i.e. sequence with single child and sequence with selection) - // can not match - } - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) - */ - @Override - public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { - return isApplicable(instance1.getTask(), instance2.getTask()); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - IIterationInstance iteration1 = (IIterationInstance) instance1; - IIterationInstance iteration2 = (IIterationInstance) instance2; - - // if both sequences do not have children, they are equal although this doesn't make sense - if ((iteration1.size() == 0) && (iteration2.size() == 0)) { - return true; - } - - if (iteration1.size() != iteration2.size()) { - return false; - } - - for (int i = 0; i < iteration1.size(); i++) { - ITaskInstance child1 = iteration1.get(i); - ITaskInstance child2 = iteration2.get(i); - - TaskEquality taskEquality = - callRuleManager(child1, child2, TaskEquality.LEXICALLY_EQUAL); - - if ((taskEquality == null) || (taskEquality == TaskEquality.UNEQUAL)) { - return false; - } - } - - return true; - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - return areLexicallyEqual(instance1, instance2); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - return areLexicallyEqual(instance1, instance2); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) - */ - @Override - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { - if (areLexicallyEqual(instance1, instance2)) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return TaskEquality.UNEQUAL; - } - } - - /** - *

- * compares two tasks with each other by calling the rule manager. If the rule manager returns - * identity, then the returned equality is set to lexically equal. The reason is, that - * the children of the iterations are compared and that therefore the distinct iterations - * can be at most lexically equal. - *

- * - * @param child1 the first task to be compared - * @param child2 the second task to be compared - * - * @return the determined equality being at most lexical equality. - */ - private TaskEquality getNodeEquality(ITask child1, ITask child2) { - TaskEquality taskEquality = callRuleManager(child1, child2, null); - - if (taskEquality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)) { - // prevent, that identical is returned, because the iterations itself are not identical - // although the iterated tasks are - if (taskEquality == TaskEquality.IDENTICAL) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return taskEquality; - } - } - - return TaskEquality.UNEQUAL; - } - - /** - *

- * compares two tasks. One of them must be a selection, the other one can be any task. - * The method returns a task equality that is not NodeEquality.UNEQUAL - * if the other task is at least semantically equal to the children of the selection. It - * returns more concrete equalities, if the equality between the other task and the children - * of the selection is more concrete. - *

- * - * @param task1 the first task to compare - * @param task2 the second task to compare - * - * @return as described - */ - private TaskEquality selectionChildrenSemanticallyEqualNode(ITask task1, ITask task2) { - ISelection selection = null; - ITask task = null; - if (task1 instanceof ISelection) { - selection = (ISelection) task1; - task = task2; - } - else if (task2 instanceof ISelection) { - selection = (ISelection) task2; - task = task1; - } - else { - return TaskEquality.UNEQUAL; - } - - // Iterations, where one has a selection and the other one not can at most be syntactically - // equal but not identical - TaskEquality commonDenominatorForAllComparisons = TaskEquality.SYNTACTICALLY_EQUAL; - - for (ITask child : selection.getChildren()) { - TaskEquality taskEquality = - callRuleManager(task, child, commonDenominatorForAllComparisons); - - if ((taskEquality == null) || (taskEquality == TaskEquality.UNEQUAL)) { - return TaskEquality.UNEQUAL; - } - - commonDenominatorForAllComparisons = - commonDenominatorForAllComparisons.getCommonDenominator(taskEquality); - } - - return commonDenominatorForAllComparisons; - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param child1 the first task to be compared - * @param child2 the second task to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITask child1, - ITask child2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(child1, child2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (child1, child2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param taskInstance1 the first task instance to be compared - * @param taskInstance2 the second task instance to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITaskInstance taskInstance1, - ITaskInstance taskInstance2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(taskInstance1, taskInstance2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (taskInstance1, taskInstance2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) + */ + @Override + public boolean areLexicallyEqual(ITask task1, ITask task2) { + final ITask child1 = ((IIteration) task1).getMarkedTask(); + final ITask child2 = ((IIteration) task2).getMarkedTask(); + + if (child1 != null) { + if (child2 == null) { + return false; + } else { + // iterations may have 3 different structures. + // 1. they have one child, which is the iterated one + // 2. they have a sequence of children, which is iterated + // 3. they have a selection of different iterated variants + // (usually the variants + // are semantically equal) + // ignore the type of the children but check them for equality. + + return getNodeEquality(child1, child2).isAtLeast( + TaskEquality.LEXICALLY_EQUAL); + } + } else if (child2 == null) { + return true; + } + + return false; + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) + */ + @Override + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final IIterationInstance iteration1 = (IIterationInstance) instance1; + final IIterationInstance iteration2 = (IIterationInstance) instance2; + + // if both sequences do not have children, they are equal although this + // doesn't make sense + if ((iteration1.size() == 0) && (iteration2.size() == 0)) { + return true; + } + + if (iteration1.size() != iteration2.size()) { + return false; + } + + for (int i = 0; i < iteration1.size(); i++) { + final ITaskInstance child1 = iteration1.get(i); + final ITaskInstance child2 = iteration2.get(i); + + final TaskEquality taskEquality = callRuleManager(child1, child2, + TaskEquality.LEXICALLY_EQUAL); + + if ((taskEquality == null) + || (taskEquality == TaskEquality.UNEQUAL)) { + return false; + } + } + + return true; + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) + */ + @Override + public boolean areSemanticallyEqual(ITask task1, ITask task2) { + return compare(task1, task2).isAtLeast(TaskEquality.SEMANTICALLY_EQUAL); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + return areLexicallyEqual(instance1, instance2); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) + */ + @Override + public boolean areSyntacticallyEqual(ITask task1, ITask task2) { + return areLexicallyEqual(task1, task2); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + return areLexicallyEqual(instance1, instance2); + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param child1 + * the first task to be compared + * @param child2 + * the second task to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITask child1, ITask child2, + TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance() + .compare(child1, child2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + child1, child2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param taskInstance1 + * the first task instance to be compared + * @param taskInstance2 + * the second task instance to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITaskInstance taskInstance1, + ITaskInstance taskInstance2, TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance().compare(taskInstance1, + taskInstance2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + taskInstance1, taskInstance2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITask, ITask) + */ + @Override + public TaskEquality compare(ITask task1, ITask task2) { + final ITask child1 = ((IIteration) task1).getMarkedTask(); + final ITask child2 = ((IIteration) task2).getMarkedTask(); + + // if both iterations do not have children, they are equal although this + // doesn't make sense + if ((child1 == null) && (child2 == null)) { + return TaskEquality.LEXICALLY_EQUAL; + } else if ((child1 == null) || (child2 == null)) { + return TaskEquality.UNEQUAL; + } + + // iterations may have 3 different structures. + // 1. they have one child, which is the iterated one + // 2. they have a sequence of children, which is iterated + // 3. they have a selection of different iterated variants (usually the + // variants are + // semantically equal) + // + // the permutations of the three variants in combination must be checked + + // check if both tasks are the same variants of iterations and if their + // children are equal. + // This condition matches, if both iterations are the same variants of + // iteration. I.e. three + // combinations of the permutation are handled herewith. + final TaskEquality taskEquality = getNodeEquality(child1, child2); + + if (taskEquality != null) { + return taskEquality; + } + + // compare one iteration with a single task as a child and another one + // with a selection of + // semantically equal tasks + return selectionChildrenSemanticallyEqualNode(child1, child2); + + // all other combinations (i.e. sequence with single child and sequence + // with selection) + // can not match + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) + */ + @Override + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { + if (areLexicallyEqual(instance1, instance2)) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return TaskEquality.UNEQUAL; + } + } + + /** + *

+ * compares two tasks with each other by calling the rule manager. If the + * rule manager returns identity, then the returned equality is set to + * lexically equal. The reason is, that the children of the iterations are + * compared and that therefore the distinct iterations can be at most + * lexically equal. + *

+ * + * @param child1 + * the first task to be compared + * @param child2 + * the second task to be compared + * + * @return the determined equality being at most lexical equality. + */ + private TaskEquality getNodeEquality(ITask child1, ITask child2) { + final TaskEquality taskEquality = callRuleManager(child1, child2, null); + + if (taskEquality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)) { + // prevent, that identical is returned, because the iterations + // itself are not identical + // although the iterated tasks are + if (taskEquality == TaskEquality.IDENTICAL) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return taskEquality; + } + } + + return TaskEquality.UNEQUAL; + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITask, ITask) + */ + @Override + public boolean isApplicable(ITask task1, ITask task2) { + return (task1 instanceof IIteration) && (task2 instanceof IIteration); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) + */ + @Override + public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { + return isApplicable(instance1.getTask(), instance2.getTask()); + } + + /** + *

+ * compares two tasks. One of them must be a selection, the other one can be + * any task. The method returns a task equality that is not + * NodeEquality.UNEQUAL if the other task is at least + * semantically equal to the children of the selection. It returns more + * concrete equalities, if the equality between the other task and the + * children of the selection is more concrete. + *

+ * + * @param task1 + * the first task to compare + * @param task2 + * the second task to compare + * + * @return as described + */ + private TaskEquality selectionChildrenSemanticallyEqualNode(ITask task1, + ITask task2) { + ISelection selection = null; + ITask task = null; + if (task1 instanceof ISelection) { + selection = (ISelection) task1; + task = task2; + } else if (task2 instanceof ISelection) { + selection = (ISelection) task2; + task = task1; + } else { + return TaskEquality.UNEQUAL; + } + + // Iterations, where one has a selection and the other one not can at + // most be syntactically + // equal but not identical + TaskEquality commonDenominatorForAllComparisons = TaskEquality.SYNTACTICALLY_EQUAL; + + for (final ITask child : selection.getChildren()) { + final TaskEquality taskEquality = callRuleManager(task, child, + commonDenominatorForAllComparisons); + + if ((taskEquality == null) + || (taskEquality == TaskEquality.UNEQUAL)) { + return TaskEquality.UNEQUAL; + } + + commonDenominatorForAllComparisons = commonDenominatorForAllComparisons + .getCommonDenominator(taskEquality); + } + + return commonDenominatorForAllComparisons; + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/SelectionComparisonRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/SelectionComparisonRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/SelectionComparisonRule.java (revision 1733) @@ -24,13 +24,15 @@ /** *

- * this task comparison rule is capable of comparing selections. If both selections do not have - * children, they are treated as lexically equal. If they have children, each child of both - * selections is compared to each child of the respective other selection. The resulting equality - * is the most concrete one of all these comparisons. I.e. if all children are at least lexically - * equal, then the selections are lexically equal. If all children are at least syntactically - * equal, then the selections are syntactically equal. If all children are at least semantically - * equal, then the selections are semantically equal. If only one of the selections has children, - * then the selections are unequal. The comparison is broken up, if only a specific equality is - * checked for and this equality is ensured. + * this task comparison rule is capable of comparing selections. If both + * selections do not have children, they are treated as lexically equal. If they + * have children, each child of both selections is compared to each child of the + * respective other selection. The resulting equality is the most concrete one + * of all these comparisons. I.e. if all children are at least lexically equal, + * then the selections are lexically equal. If all children are at least + * syntactically equal, then the selections are syntactically equal. If all + * children are at least semantically equal, then the selections are + * semantically equal. If only one of the selections has children, then the + * selections are unequal. The comparison is broken up, if only a specific + * equality is checked for and this equality is ensured. *

* @@ -40,308 +42,363 @@ public class SelectionComparisonRule implements TaskComparisonRule { - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITask, ITask) - */ - @Override - public boolean isApplicable(ITask task1, ITask task2) { - return (task1 instanceof ISelection) && (task2 instanceof ISelection); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) - */ - @Override - public boolean areLexicallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) - */ - @Override - public boolean areSyntacticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) - */ - @Override - public boolean areSemanticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITask, ITask) - */ - @Override - public TaskEquality compare(ITask task1, ITask task2) { - return getEquality(task1, task2, null); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) - */ - @Override - public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { - return isApplicable(instance1.getTask(), instance2.getTask()); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) - */ - @Override - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { - return getEquality(instance1, instance2, null); - } - - /** - *

- * compares two selections with each other checking for the provided required level of - * equality. If this level is ensured, the method immediately returns. The more concrete - * the required equality level, the more checks this method performs. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality. - */ - private TaskEquality getEquality(ITask task1, ITask task2, TaskEquality requiredEqualityLevel) { - List children1 = ((ISelection) task1).getChildren(); - List children2 = ((ISelection) task2).getChildren(); - - // if both selections do not have children, they are lexically equal. If only one of them - // has children, they are unequal. - if ((children1.size() == 0) && (children2.size() == 0)) { - return TaskEquality.LEXICALLY_EQUAL; - } - else if ((children1.size() == 0) || (children2.size() == 0)) { - return TaskEquality.UNEQUAL; - } - - if (requiredEqualityLevel == null) { - // calculate the common equality level for all children of both selections. - // do it in both directions to ensure commutative comparison - return getMostConcreteEqualityLevel(children1, children2); - } - else { - // we are searching for a specific equality - if (checkEqualityLevel(children1, children2, requiredEqualityLevel)) { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } - } - - /** - *

- * determines the most concrete equality level for all tasks in the first list compared to all - * tasks in the second list. It is sufficient, if there is one task in one list for which there - * exist an equal task in the other list. - *

- * - * @param children1 the first list to be compared - * @param children2 the second list to be compared - * - * @return the most concrete task equality identified for all tasks in the first list with - * respect to the second list - */ - private TaskEquality getMostConcreteEqualityLevel(List children1, List children2) - { - TaskEquality childEquality; - TaskEquality currentEquality; - for (ITask child1 : children1) { - childEquality = null; - for (ITask child2 : children2) { - currentEquality = callRuleManager(child1, child2, null); - if ((currentEquality != null) && (currentEquality != TaskEquality.UNEQUAL)) { - if (childEquality == null) { - childEquality = currentEquality; - } - else { - childEquality = childEquality.getCommonDenominator(currentEquality); - } - - if (childEquality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)) { - // as we calculate the most concrete equality, we can break up here - return TaskEquality.LEXICALLY_EQUAL; - } - } - } - } - - // as the comparison should be commutative, we do not need to check, if in list 2 there is - // a child equal to one in list 1 - return TaskEquality.UNEQUAL; - } - - /** - *

- * ensures for the two given lists, that for at least one task in the first list there is a task - * in the second list being on the given level equal to the task in the first list. - *

- * - * @param children1 the first list to be compared - * @param children2 the second list to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return true if there is a task in the first list that has an equal task in the second list - * when considering the given equality level, false else. - */ - private boolean checkEqualityLevel(List children1, - List children2, - TaskEquality requiredEqualityLevel) - { - TaskEquality currentEquality; - for (ITask child1 : children1) { - for (ITask child2 : children2) { - currentEquality = callRuleManager(child1, child2, requiredEqualityLevel); - if ((currentEquality != null) && (currentEquality.isAtLeast(requiredEqualityLevel))) - { - // we found at least one equal child with sufficient equality in the - // second list. So be can break up for this child. - return true; - } - } - } - - return false; - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param child1 the first task to be compared - * @param child2 the second task to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITask child1, - ITask child2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(child1, child2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (child1, child2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } - - /** - *

- * compares two selection instances with each other checking for the provided required level of - * equality. If this level is ensured, the method immediately returns. The more concrete - * the required equality level, the more checks this method performs. - *

- * - * @param taskInstance1 the first task instance to be compared - * @param taskInstance2 the second task instance to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality. - */ - private TaskEquality getEquality(ITaskInstance taskInstance1, - ITaskInstance taskInstance2, - TaskEquality requiredEqualityLevel) - { - ITaskInstance child1 = ((ISelectionInstance) taskInstance1).getChild(); - ITaskInstance child2 = ((ISelectionInstance) taskInstance2).getChild(); - - // if both selections do not have children, they are lexically equal. If only one of them - // has children, they are unequal. - if ((child1 == null) && (child2 == null)) { - return TaskEquality.LEXICALLY_EQUAL; - } - else if ((child1 == null) || (child2 == null)) { - return TaskEquality.UNEQUAL; - } - - TaskEquality equality = callRuleManager(child1, child2, requiredEqualityLevel); - - if (equality == TaskEquality.IDENTICAL) { - // two different selection instances can be at most lexically equal even if their - // children are identical - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return equality; - } - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param taskInstance1 the first task instance to be compared - * @param taskInstance2 the second task instance to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITaskInstance taskInstance1, - ITaskInstance taskInstance2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(taskInstance1, taskInstance2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (taskInstance1, taskInstance2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) + */ + @Override + public boolean areLexicallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) + */ + @Override + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) + */ + @Override + public boolean areSemanticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) + */ + @Override + public boolean areSyntacticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param child1 + * the first task to be compared + * @param child2 + * the second task to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITask child1, ITask child2, + TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance() + .compare(child1, child2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + child1, child2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param taskInstance1 + * the first task instance to be compared + * @param taskInstance2 + * the second task instance to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITaskInstance taskInstance1, + ITaskInstance taskInstance2, TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance().compare(taskInstance1, + taskInstance2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + taskInstance1, taskInstance2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /** + *

+ * ensures for the two given lists, that for at least one task in the first + * list there is a task in the second list being on the given level equal to + * the task in the first list. + *

+ * + * @param children1 + * the first list to be compared + * @param children2 + * the second list to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return true if there is a task in the first list that has an equal task + * in the second list when considering the given equality level, + * false else. + */ + private boolean checkEqualityLevel(List children1, + List children2, TaskEquality requiredEqualityLevel) { + TaskEquality currentEquality; + for (final ITask child1 : children1) { + for (final ITask child2 : children2) { + currentEquality = callRuleManager(child1, child2, + requiredEqualityLevel); + if ((currentEquality != null) + && (currentEquality.isAtLeast(requiredEqualityLevel))) { + // we found at least one equal child with sufficient + // equality in the + // second list. So be can break up for this child. + return true; + } + } + } + + return false; + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITask, ITask) + */ + @Override + public TaskEquality compare(ITask task1, ITask task2) { + return getEquality(task1, task2, null); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) + */ + @Override + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { + return getEquality(instance1, instance2, null); + } + + /** + *

+ * compares two selections with each other checking for the provided + * required level of equality. If this level is ensured, the method + * immediately returns. The more concrete the required equality level, the + * more checks this method performs. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality. + */ + private TaskEquality getEquality(ITask task1, ITask task2, + TaskEquality requiredEqualityLevel) { + final List children1 = ((ISelection) task1).getChildren(); + final List children2 = ((ISelection) task2).getChildren(); + + // if both selections do not have children, they are lexically equal. If + // only one of them + // has children, they are unequal. + if ((children1.size() == 0) && (children2.size() == 0)) { + return TaskEquality.LEXICALLY_EQUAL; + } else if ((children1.size() == 0) || (children2.size() == 0)) { + return TaskEquality.UNEQUAL; + } + + if (requiredEqualityLevel == null) { + // calculate the common equality level for all children of both + // selections. + // do it in both directions to ensure commutative comparison + return getMostConcreteEqualityLevel(children1, children2); + } else { + // we are searching for a specific equality + if (checkEqualityLevel(children1, children2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + } + + /** + *

+ * compares two selection instances with each other checking for the + * provided required level of equality. If this level is ensured, the method + * immediately returns. The more concrete the required equality level, the + * more checks this method performs. + *

+ * + * @param taskInstance1 + * the first task instance to be compared + * @param taskInstance2 + * the second task instance to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality. + */ + private TaskEquality getEquality(ITaskInstance taskInstance1, + ITaskInstance taskInstance2, TaskEquality requiredEqualityLevel) { + final ITaskInstance child1 = ((ISelectionInstance) taskInstance1) + .getChild(); + final ITaskInstance child2 = ((ISelectionInstance) taskInstance2) + .getChild(); + + // if both selections do not have children, they are lexically equal. If + // only one of them + // has children, they are unequal. + if ((child1 == null) && (child2 == null)) { + return TaskEquality.LEXICALLY_EQUAL; + } else if ((child1 == null) || (child2 == null)) { + return TaskEquality.UNEQUAL; + } + + final TaskEquality equality = callRuleManager(child1, child2, + requiredEqualityLevel); + + if (equality == TaskEquality.IDENTICAL) { + // two different selection instances can be at most lexically equal + // even if their + // children are identical + return TaskEquality.LEXICALLY_EQUAL; + } else { + return equality; + } + } + + /** + *

+ * determines the most concrete equality level for all tasks in the first + * list compared to all tasks in the second list. It is sufficient, if there + * is one task in one list for which there exist an equal task in the other + * list. + *

+ * + * @param children1 + * the first list to be compared + * @param children2 + * the second list to be compared + * + * @return the most concrete task equality identified for all tasks in the + * first list with respect to the second list + */ + private TaskEquality getMostConcreteEqualityLevel(List children1, + List children2) { + TaskEquality childEquality; + TaskEquality currentEquality; + for (final ITask child1 : children1) { + childEquality = null; + for (final ITask child2 : children2) { + currentEquality = callRuleManager(child1, child2, null); + if ((currentEquality != null) + && (currentEquality != TaskEquality.UNEQUAL)) { + if (childEquality == null) { + childEquality = currentEquality; + } else { + childEquality = childEquality + .getCommonDenominator(currentEquality); + } + + if (childEquality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)) { + // as we calculate the most concrete equality, we can + // break up here + return TaskEquality.LEXICALLY_EQUAL; + } + } + } + } + + // as the comparison should be commutative, we do not need to check, if + // in list 2 there is + // a child equal to one in list 1 + return TaskEquality.UNEQUAL; + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITask, ITask) + */ + @Override + public boolean isApplicable(ITask task1, ITask task2) { + return (task1 instanceof ISelection) && (task2 instanceof ISelection); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) + */ + @Override + public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { + return isApplicable(instance1.getTask(), instance2.getTask()); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/SequenceComparisonRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/SequenceComparisonRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/SequenceComparisonRule.java (revision 1733) @@ -24,8 +24,8 @@ /** *

- * This rule is capable of comparing sequences. If both sequences do not have children, they are - * treated as lexically equal. Sequences are lexically equal, if they have the same number and - * order of lexically equal children. The rule can not decide, if two sequences are syntactically - * or semantically equal. + * This rule is capable of comparing sequences. If both sequences do not have + * children, they are treated as lexically equal. Sequences are lexically equal, + * if they have the same number and order of lexically equal children. The rule + * can not decide, if two sequences are syntactically or semantically equal. *

* @@ -35,239 +35,289 @@ public class SequenceComparisonRule implements TaskComparisonRule { - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITask, ITask) - */ - @Override - public boolean isApplicable(ITask task1, ITask task2) { - return (task1 instanceof ISequence) && (task2 instanceof ISequence); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) - */ - @Override - public boolean areLexicallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) - */ - @Override - public boolean areSyntacticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) - */ - @Override - public boolean areSemanticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITask, ITask) - */ - @Override - public TaskEquality compare(ITask task1, ITask task2) { - return getEquality(task1, task2, null); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) - */ - @Override - public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { - return isApplicable(instance1.getTask(), instance2.getTask()); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) - */ - @Override - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { - return getEquality(instance1, instance2, null); - } - - /** - *

- * compares two sequences with each other checking for the provided required level of - * equality. If this level is ensured, the method immediately returns. The more concrete - * the required equality level, the more checks this method performs. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality. - */ - private TaskEquality getEquality(ITask task1, ITask task2, TaskEquality requiredEqualityLevel) { - List children1 = ((ISequence) task1).getChildren(); - List children2 = ((ISequence) task2).getChildren(); - - // if both sequences do not have children, they are equal although this doesn't make sense - if ((children1.size() == 0) && (children2.size() == 0)) { - return TaskEquality.LEXICALLY_EQUAL; - } - - if (children1.size() != children2.size()) { - return TaskEquality.UNEQUAL; - } - - TaskEquality resultingEquality = TaskEquality.LEXICALLY_EQUAL; - for (int i = 0; i < children1.size(); i++) { - ITask child1 = children1.get(i); - ITask child2 = children2.get(i); - - TaskEquality taskEquality = callRuleManager(child1, child2, requiredEqualityLevel); - - if ((taskEquality == null) || (taskEquality == TaskEquality.UNEQUAL)) { - return TaskEquality.UNEQUAL; - } - - resultingEquality = resultingEquality.getCommonDenominator(taskEquality); - } - - return resultingEquality; - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param child1 the first task to be compared - * @param child2 the second task to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITask child1, - ITask child2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(child1, child2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (child1, child2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } - - /** - *

- * compares two sequence instances with each other checking for the provided required level of - * equality. If this level is ensured, the method immediately returns. The more concrete - * the required equality level, the more checks this method performs. - *

- * - * @param taskInstance1 the first task instance to be compared - * @param taskInstance2 the second task instance to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality. - */ - private TaskEquality getEquality(ITaskInstance taskInstance1, - ITaskInstance taskInstance2, - TaskEquality requiredEqualityLevel) - { - ISequenceInstance sequence1 = (ISequenceInstance) taskInstance1; - ISequenceInstance sequence2 = (ISequenceInstance) taskInstance2; - - // if both sequences do not have children, they are equal although this doesn't make sense - if ((sequence1.size() == 0) && (sequence2.size() == 0)) { - return TaskEquality.LEXICALLY_EQUAL; - } - - if (sequence1.size() != sequence2.size()) { - return TaskEquality.UNEQUAL; - } - - TaskEquality resultingEquality = TaskEquality.LEXICALLY_EQUAL; - for (int i = 0; i < sequence1.size(); i++) { - ITaskInstance child1 = sequence1.get(i); - ITaskInstance child2 = sequence2.get(i); - - TaskEquality taskEquality = callRuleManager(child1, child2, requiredEqualityLevel); - - if ((taskEquality == null) || (taskEquality == TaskEquality.UNEQUAL)) { - return TaskEquality.UNEQUAL; - } - - resultingEquality = resultingEquality.getCommonDenominator(taskEquality); - } - - return resultingEquality; - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param taskInstance1 the first task instance to be compared - * @param taskInstance2 the second task instance to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITaskInstance taskInstance1, - ITaskInstance taskInstance2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(taskInstance1, taskInstance2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (taskInstance1, taskInstance2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) + */ + @Override + public boolean areLexicallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) + */ + @Override + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) + */ + @Override + public boolean areSemanticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) + */ + @Override + public boolean areSyntacticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param child1 + * the first task to be compared + * @param child2 + * the second task to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITask child1, ITask child2, + TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance() + .compare(child1, child2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + child1, child2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param taskInstance1 + * the first task instance to be compared + * @param taskInstance2 + * the second task instance to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITaskInstance taskInstance1, + ITaskInstance taskInstance2, TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance().compare(taskInstance1, + taskInstance2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + taskInstance1, taskInstance2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITask, ITask) + */ + @Override + public TaskEquality compare(ITask task1, ITask task2) { + return getEquality(task1, task2, null); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) + */ + @Override + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { + return getEquality(instance1, instance2, null); + } + + /** + *

+ * compares two sequences with each other checking for the provided required + * level of equality. If this level is ensured, the method immediately + * returns. The more concrete the required equality level, the more checks + * this method performs. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality. + */ + private TaskEquality getEquality(ITask task1, ITask task2, + TaskEquality requiredEqualityLevel) { + final List children1 = ((ISequence) task1).getChildren(); + final List children2 = ((ISequence) task2).getChildren(); + + // if both sequences do not have children, they are equal although this + // doesn't make sense + if ((children1.size() == 0) && (children2.size() == 0)) { + return TaskEquality.LEXICALLY_EQUAL; + } + + if (children1.size() != children2.size()) { + return TaskEquality.UNEQUAL; + } + + TaskEquality resultingEquality = TaskEquality.LEXICALLY_EQUAL; + for (int i = 0; i < children1.size(); i++) { + final ITask child1 = children1.get(i); + final ITask child2 = children2.get(i); + + final TaskEquality taskEquality = callRuleManager(child1, child2, + requiredEqualityLevel); + + if ((taskEquality == null) + || (taskEquality == TaskEquality.UNEQUAL)) { + return TaskEquality.UNEQUAL; + } + + resultingEquality = resultingEquality + .getCommonDenominator(taskEquality); + } + + return resultingEquality; + } + + /** + *

+ * compares two sequence instances with each other checking for the provided + * required level of equality. If this level is ensured, the method + * immediately returns. The more concrete the required equality level, the + * more checks this method performs. + *

+ * + * @param taskInstance1 + * the first task instance to be compared + * @param taskInstance2 + * the second task instance to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality. + */ + private TaskEquality getEquality(ITaskInstance taskInstance1, + ITaskInstance taskInstance2, TaskEquality requiredEqualityLevel) { + final ISequenceInstance sequence1 = (ISequenceInstance) taskInstance1; + final ISequenceInstance sequence2 = (ISequenceInstance) taskInstance2; + + // if both sequences do not have children, they are equal although this + // doesn't make sense + if ((sequence1.size() == 0) && (sequence2.size() == 0)) { + return TaskEquality.LEXICALLY_EQUAL; + } + + if (sequence1.size() != sequence2.size()) { + return TaskEquality.UNEQUAL; + } + + TaskEquality resultingEquality = TaskEquality.LEXICALLY_EQUAL; + for (int i = 0; i < sequence1.size(); i++) { + final ITaskInstance child1 = sequence1.get(i); + final ITaskInstance child2 = sequence2.get(i); + + final TaskEquality taskEquality = callRuleManager(child1, child2, + requiredEqualityLevel); + + if ((taskEquality == null) + || (taskEquality == TaskEquality.UNEQUAL)) { + return TaskEquality.UNEQUAL; + } + + resultingEquality = resultingEquality + .getCommonDenominator(taskEquality); + } + + return resultingEquality; + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITask, ITask) + */ + @Override + public boolean isApplicable(ITask task1, ITask task2) { + return (task1 instanceof ISequence) && (task2 instanceof ISequence); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) + */ + @Override + public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { + return isApplicable(instance1.getTask(), instance2.getTask()); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskAndIterationComparisonRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskAndIterationComparisonRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskAndIterationComparisonRule.java (revision 1733) @@ -23,309 +23,355 @@ *

* This class is capable of comparing any task which is not an iteration with an - * iteration. This is needed, because iterations may iterate exactly that task. In this - * case, the iteration would be equal to that task if it was executed exactly once. The rule - * returns lexically equal, it the child of the iteration is lexically equal to the task - * or if the child of the iteration is a selection and this selections contains a lexically equal - * task. The same applies for syntactical and semantical equality. + * iteration. This is needed, because iterations may iterate exactly that task. + * In this case, the iteration would be equal to that task if it was executed + * exactly once. The rule returns lexically equal, it the child of the iteration + * is lexically equal to the task or if the child of the iteration is a + * selection and this selections contains a lexically equal task. The same + * applies for syntactical and semantical equality. *

- + * * @author Patrick Harms */ public class TaskAndIterationComparisonRule implements TaskComparisonRule { - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITask, ITask) - */ - @Override - public boolean isApplicable(ITask task1, ITask task2) { - return ((task1 instanceof IIteration) && (!(task2 instanceof IIteration))) || - ((task2 instanceof IIteration) && (!(task1 instanceof IIteration))); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) - */ - @Override - public boolean areLexicallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) - */ - @Override - public boolean areSyntacticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) - */ - @Override - public boolean areSemanticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITask, ITask) - */ - @Override - public TaskEquality compare(ITask task1, ITask task2) { - return getEquality(task1, task2, null); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) - */ - @Override - public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { - return isApplicable(instance1.getTask(), instance2.getTask()); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) - */ - @Override - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { - return getEquality(instance1, instance2, null); - } - - /** - *

- * compares two tasks with each other checking for the provided required level of - * equality. One of the tasks must be an iteration, the other one not. If this is not the - * case, the method returns null. The returned equality level is at most lexical equality - * as the iteration can not be identical to something not being an iteration. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality. - */ - private TaskEquality getEquality(ITask task1, ITask task2, TaskEquality requiredEqualityLevel) { - IIteration iteration = null; - ITask task = null; - - if (task1 instanceof IIteration) { - if (task2 instanceof IIteration) { - // the rule is not responsible for two iterations - return null; - } - - iteration = (IIteration) task1; - task = task2; - } - else if (task2 instanceof IIteration) { - if (task1 instanceof IIteration) { - // the rule is not responsible for two iterations - return null; - } - - iteration = (IIteration) task2; - task = task1; - } - else { - return null; - } - - ITask child = iteration.getMarkedTask(); - - // now, that we found the iteration and the task, lets compare the child of the iteration - // with the task. - if (child == null) { - return null; - } - - TaskEquality taskEquality = callRuleManager(child, task, requiredEqualityLevel); - - // although the subtask may be identical to the task, we can not return identical, as - // the iteration is not identical to the task, but at most lexically equal - if (taskEquality == TaskEquality.IDENTICAL) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return taskEquality; - } - - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param child1 the first task to be compared - * @param child2 the second task to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITask child1, - ITask child2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(child1, child2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (child1, child2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } - - /** - *

- * compares two task instances with each other checking for the provided required level of - * equality. One of the task instances must be a iteration, the other one not. If this is not - * the case, the method returns null. The returned equality level is at most lexical equality - * as the iteration can not be identical to something not being a iteration. - *

- * - * @param taskInstance1 the first task instance to be compared - * @param taskInstance2 the second task instance to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality. - */ - private TaskEquality getEquality(ITaskInstance taskInstance1, - ITaskInstance taskInstance2, - TaskEquality requiredEqualityLevel) - { - IIterationInstance iteration = null; - ITaskInstance task = null; - - if (taskInstance1 instanceof IIterationInstance) { - if (taskInstance2 instanceof IIterationInstance) { - // the rule is not responsible for two iterations - return null; - } - - iteration = (IIterationInstance) taskInstance1; - task = taskInstance2; - } - else if (taskInstance2 instanceof IIterationInstance) { - if (taskInstance1 instanceof IIterationInstance) { - // the rule is not responsible for two iterations - return null; - } - - iteration = (IIterationInstance) taskInstance2; - task = taskInstance1; - } - else { - return null; - } - - // now, that we found the iteration and the task, lets compare the children of the iteration - // with the task. - - if (iteration.size() < 1) { - return null; - } - - TaskEquality mostConcreteNodeEquality = null; - - for (ITaskInstance child : iteration) { - TaskEquality taskEquality = callRuleManager(child, task, requiredEqualityLevel); - - if (taskEquality != TaskEquality.UNEQUAL) { - if (mostConcreteNodeEquality == null) { - mostConcreteNodeEquality = taskEquality; - } - else if (mostConcreteNodeEquality.isAtLeast(taskEquality)) { - mostConcreteNodeEquality = taskEquality; - - } - - if ((requiredEqualityLevel != null) && - (mostConcreteNodeEquality.isAtLeast(requiredEqualityLevel))) - { - // if we found one child of the selection that is as equal as required, then - // we can consider the selection to be sufficiently equal to the other task. - // So we break up checking further children. - break; - } - } - } - - // although the subtask may be identical to the task, we can not return identical, as - // the selection is not identical to the task, but at most lexically equal - if (mostConcreteNodeEquality == TaskEquality.IDENTICAL) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return mostConcreteNodeEquality; - } - - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param taskInstance1 the first task instance to be compared - * @param taskInstance2 the second task instance to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITaskInstance taskInstance1, - ITaskInstance taskInstance2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(taskInstance1, taskInstance2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (taskInstance1, taskInstance2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) + */ + @Override + public boolean areLexicallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) + */ + @Override + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) + */ + @Override + public boolean areSemanticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) + */ + @Override + public boolean areSyntacticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param child1 + * the first task to be compared + * @param child2 + * the second task to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITask child1, ITask child2, + TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance() + .compare(child1, child2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + child1, child2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param taskInstance1 + * the first task instance to be compared + * @param taskInstance2 + * the second task instance to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITaskInstance taskInstance1, + ITaskInstance taskInstance2, TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance().compare(taskInstance1, + taskInstance2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + taskInstance1, taskInstance2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITask, ITask) + */ + @Override + public TaskEquality compare(ITask task1, ITask task2) { + return getEquality(task1, task2, null); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) + */ + @Override + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { + return getEquality(instance1, instance2, null); + } + + /** + *

+ * compares two tasks with each other checking for the provided required + * level of equality. One of the tasks must be an iteration, the other one + * not. If this is not the case, the method returns null. The returned + * equality level is at most lexical equality as the iteration can not be + * identical to something not being an iteration. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality. + */ + private TaskEquality getEquality(ITask task1, ITask task2, + TaskEquality requiredEqualityLevel) { + IIteration iteration = null; + ITask task = null; + + if (task1 instanceof IIteration) { + if (task2 instanceof IIteration) { + // the rule is not responsible for two iterations + return null; + } + + iteration = (IIteration) task1; + task = task2; + } else if (task2 instanceof IIteration) { + if (task1 instanceof IIteration) { + // the rule is not responsible for two iterations + return null; + } + + iteration = (IIteration) task2; + task = task1; + } else { + return null; + } + + final ITask child = iteration.getMarkedTask(); + + // now, that we found the iteration and the task, lets compare the child + // of the iteration + // with the task. + if (child == null) { + return null; + } + + final TaskEquality taskEquality = callRuleManager(child, task, + requiredEqualityLevel); + + // although the subtask may be identical to the task, we can not return + // identical, as + // the iteration is not identical to the task, but at most lexically + // equal + if (taskEquality == TaskEquality.IDENTICAL) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return taskEquality; + } + + } + + /** + *

+ * compares two task instances with each other checking for the provided + * required level of equality. One of the task instances must be a + * iteration, the other one not. If this is not the case, the method returns + * null. The returned equality level is at most lexical equality as the + * iteration can not be identical to something not being a iteration. + *

+ * + * @param taskInstance1 + * the first task instance to be compared + * @param taskInstance2 + * the second task instance to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality. + */ + private TaskEquality getEquality(ITaskInstance taskInstance1, + ITaskInstance taskInstance2, TaskEquality requiredEqualityLevel) { + IIterationInstance iteration = null; + ITaskInstance task = null; + + if (taskInstance1 instanceof IIterationInstance) { + if (taskInstance2 instanceof IIterationInstance) { + // the rule is not responsible for two iterations + return null; + } + + iteration = (IIterationInstance) taskInstance1; + task = taskInstance2; + } else if (taskInstance2 instanceof IIterationInstance) { + if (taskInstance1 instanceof IIterationInstance) { + // the rule is not responsible for two iterations + return null; + } + + iteration = (IIterationInstance) taskInstance2; + task = taskInstance1; + } else { + return null; + } + + // now, that we found the iteration and the task, lets compare the + // children of the iteration + // with the task. + + if (iteration.size() < 1) { + return null; + } + + TaskEquality mostConcreteNodeEquality = null; + + for (final ITaskInstance child : iteration) { + final TaskEquality taskEquality = callRuleManager(child, task, + requiredEqualityLevel); + + if (taskEquality != TaskEquality.UNEQUAL) { + if (mostConcreteNodeEquality == null) { + mostConcreteNodeEquality = taskEquality; + } else if (mostConcreteNodeEquality.isAtLeast(taskEquality)) { + mostConcreteNodeEquality = taskEquality; + + } + + if ((requiredEqualityLevel != null) + && (mostConcreteNodeEquality + .isAtLeast(requiredEqualityLevel))) { + // if we found one child of the selection that is as equal + // as required, then + // we can consider the selection to be sufficiently equal to + // the other task. + // So we break up checking further children. + break; + } + } + } + + // although the subtask may be identical to the task, we can not return + // identical, as + // the selection is not identical to the task, but at most lexically + // equal + if (mostConcreteNodeEquality == TaskEquality.IDENTICAL) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return mostConcreteNodeEquality; + } + + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITask, ITask) + */ + @Override + public boolean isApplicable(ITask task1, ITask task2) { + return ((task1 instanceof IIteration) && (!(task2 instanceof IIteration))) + || ((task2 instanceof IIteration) && (!(task1 instanceof IIteration))); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) + */ + @Override + public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { + return isApplicable(instance1.getTask(), instance2.getTask()); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskAndSelectionComparisonRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskAndSelectionComparisonRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskAndSelectionComparisonRule.java (revision 1733) @@ -25,309 +25,355 @@ *

* This class is capable of comparing any task which is not a selection with a - * selection. This is needed, because selections may contain exactly that task. Therefore, if - * this task is selected out of a selection the selection is equal to the task itself. - * The rule returns lexically equal, if the selection contains a lexically equal task. The same - * applies for syntactical and semantical equality. + * selection. This is needed, because selections may contain exactly that task. + * Therefore, if this task is selected out of a selection the selection is equal + * to the task itself. The rule returns lexically equal, if the selection + * contains a lexically equal task. The same applies for syntactical and + * semantical equality. *

- + * * @author Patrick Harms */ public class TaskAndSelectionComparisonRule implements TaskComparisonRule { - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITask, ITask) - */ - @Override - public boolean isApplicable(ITask task1, ITask task2) { - return ((task1 instanceof ISelection) && (!(task2 instanceof ISelection))) || - ((task2 instanceof ISelection) && (!(task1 instanceof ISelection))); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) - */ - @Override - public boolean areLexicallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) - */ - @Override - public boolean areSyntacticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) - */ - @Override - public boolean areSemanticallyEqual(ITask task1, ITask task2) { - TaskEquality equality = getEquality(task1, task2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITask, ITask) - */ - @Override - public TaskEquality compare(ITask task1, ITask task2) { - return getEquality(task1, task2, null); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) - */ - @Override - public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { - return isApplicable(instance1.getTask(), instance2.getTask()); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.LEXICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SYNTACTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - TaskEquality equality = getEquality(instance1, instance2, TaskEquality.SEMANTICALLY_EQUAL); - return (equality != null) && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); - } - - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) - */ - @Override - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { - return getEquality(instance1, instance2, null); - } - - /** - *

- * compares two tasks with each other checking for the provided required level of - * equality. One of the tasks must be a selection, the other one not. If this is not the - * case, the method returns null. The returned equality level is at most lexical equality - * as the selection can not be identical to something not being a selection. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality. - */ - private TaskEquality getEquality(ITask task1, ITask task2, TaskEquality requiredEqualityLevel) { - ISelection selection = null; - ITask task = null; - - if (task1 instanceof ISelection) { - if (task2 instanceof ISelection) { - // the rule is not responsible for two selections - return null; - } - - selection = (ISelection) task1; - task = task2; - } - else if (task2 instanceof ISelection) { - if (task1 instanceof ISelection) { - // the rule is not responsible for two selections - return null; - } - - selection = (ISelection) task2; - task = task1; - } - else { - return null; - } - - // now, that we found the selection and the task, lets compare the children of the selection - // with the task. - List children = selection.getChildren(); - - if (children.size() < 1) { - return null; - } - - TaskEquality mostConcreteNodeEquality = null; - - for (ITask child : children) { - TaskEquality taskEquality = callRuleManager(child, task, requiredEqualityLevel); - - if (taskEquality != TaskEquality.UNEQUAL) { - if (mostConcreteNodeEquality == null) { - mostConcreteNodeEquality = taskEquality; - } - else if (mostConcreteNodeEquality.isAtLeast(taskEquality)) { - mostConcreteNodeEquality = taskEquality; - - } - - if ((requiredEqualityLevel != null) && - (mostConcreteNodeEquality.isAtLeast(requiredEqualityLevel))) - { - // if we found one child of the selection that is as equal as required, then - // we can consider the selection to be sufficiently equal to the other task. - // So we break up checking further children. - break; - } - } - } - - // although the subtask may be identical to the task, we can not return identical, as - // the selection is not identical to the task, but at most lexically equal - if (mostConcreteNodeEquality == TaskEquality.IDENTICAL) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return mostConcreteNodeEquality; - } - - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param child1 the first task to be compared - * @param child2 the second task to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITask child1, - ITask child2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(child1, child2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (child1, child2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } - - /** - *

- * compares two task instances with each other checking for the provided required level of - * equality. One of the task instances must be a selection, the other one not. If this is not - * the case, the method returns null. The returned equality level is at most lexical equality - * as the selection can not be identical to something not being a selection. - *

- * - * @param taskInstance1 the first task instance to be compared - * @param taskInstance2 the second task instance to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality. - */ - private TaskEquality getEquality(ITaskInstance taskInstance1, - ITaskInstance taskInstance2, - TaskEquality requiredEqualityLevel) - { - ISelectionInstance selection = null; - ITaskInstance task = null; - - if (taskInstance1 instanceof ISelectionInstance) { - if (taskInstance2 instanceof ISelectionInstance) { - // the rule is not responsible for two selections - return null; - } - - selection = (ISelectionInstance) taskInstance1; - task = taskInstance2; - } - else if (taskInstance2 instanceof ISelectionInstance) { - if (taskInstance1 instanceof ISelectionInstance) { - // the rule is not responsible for two selections - return null; - } - - selection = (ISelectionInstance) taskInstance2; - task = taskInstance1; - } - else { - return null; - } - - // now, that we found the selection and the task, lets compare the child of the selection - // with the task. - ITaskInstance child = selection.getChild(); - - if (child == null) { - return null; - } - - TaskEquality taskEquality = callRuleManager(child, task, requiredEqualityLevel); - - // although the subtask may be identical to the task, we can not return identical, as - // the selection is not identical to the task, but at most lexically equal - if (taskEquality == TaskEquality.IDENTICAL) { - return TaskEquality.LEXICALLY_EQUAL; - } - else { - return taskEquality; - } - - } - - /** - *

- * used to to call the task equality rule manager for the comparison of the two provided - * children. If no required equality level is provided, than the most concrete equality is - * returned. Otherwise, the required equality is returned as long as the children are equal - * on that level. - *

- * - * @param taskInstance1 the first task instance to be compared - * @param taskInstance2 the second task instance to be compared - * @param requiredEqualityLevel the equality level to be checked for - * - * @return the determined equality - */ - private TaskEquality callRuleManager(ITaskInstance taskInstance1, - ITaskInstance taskInstance2, - TaskEquality requiredEqualityLevel) - { - if (requiredEqualityLevel == null) { - return TaskEqualityRuleManager.getInstance().compare(taskInstance1, taskInstance2); - } - else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual - (taskInstance1, taskInstance2, requiredEqualityLevel)) - { - return requiredEqualityLevel; - } - else { - return TaskEquality.UNEQUAL; - } - } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) + */ + @Override + public boolean areLexicallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) + */ + @Override + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.LEXICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.LEXICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) + */ + @Override + public boolean areSemanticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SEMANTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SEMANTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) + */ + @Override + public boolean areSyntacticallyEqual(ITask task1, ITask task2) { + final TaskEquality equality = getEquality(task1, task2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + final TaskEquality equality = getEquality(instance1, instance2, + TaskEquality.SYNTACTICALLY_EQUAL); + return (equality != null) + && (equality.isAtLeast(TaskEquality.SYNTACTICALLY_EQUAL)); + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param child1 + * the first task to be compared + * @param child2 + * the second task to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITask child1, ITask child2, + TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance() + .compare(child1, child2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + child1, child2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /** + *

+ * used to to call the task equality rule manager for the comparison of the + * two provided children. If no required equality level is provided, than + * the most concrete equality is returned. Otherwise, the required equality + * is returned as long as the children are equal on that level. + *

+ * + * @param taskInstance1 + * the first task instance to be compared + * @param taskInstance2 + * the second task instance to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality + */ + private TaskEquality callRuleManager(ITaskInstance taskInstance1, + ITaskInstance taskInstance2, TaskEquality requiredEqualityLevel) { + if (requiredEqualityLevel == null) { + return TaskEqualityRuleManager.getInstance().compare(taskInstance1, + taskInstance2); + } else if (TaskEqualityRuleManager.getInstance().areAtLeastEqual( + taskInstance1, taskInstance2, requiredEqualityLevel)) { + return requiredEqualityLevel; + } else { + return TaskEquality.UNEQUAL; + } + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITask, ITask) + */ + @Override + public TaskEquality compare(ITask task1, ITask task2) { + return getEquality(task1, task2, null); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) + */ + @Override + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { + return getEquality(instance1, instance2, null); + } + + /** + *

+ * compares two tasks with each other checking for the provided required + * level of equality. One of the tasks must be a selection, the other one + * not. If this is not the case, the method returns null. The returned + * equality level is at most lexical equality as the selection can not be + * identical to something not being a selection. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality. + */ + private TaskEquality getEquality(ITask task1, ITask task2, + TaskEquality requiredEqualityLevel) { + ISelection selection = null; + ITask task = null; + + if (task1 instanceof ISelection) { + if (task2 instanceof ISelection) { + // the rule is not responsible for two selections + return null; + } + + selection = (ISelection) task1; + task = task2; + } else if (task2 instanceof ISelection) { + if (task1 instanceof ISelection) { + // the rule is not responsible for two selections + return null; + } + + selection = (ISelection) task2; + task = task1; + } else { + return null; + } + + // now, that we found the selection and the task, lets compare the + // children of the selection + // with the task. + final List children = selection.getChildren(); + + if (children.size() < 1) { + return null; + } + + TaskEquality mostConcreteNodeEquality = null; + + for (final ITask child : children) { + final TaskEquality taskEquality = callRuleManager(child, task, + requiredEqualityLevel); + + if (taskEquality != TaskEquality.UNEQUAL) { + if (mostConcreteNodeEquality == null) { + mostConcreteNodeEquality = taskEquality; + } else if (mostConcreteNodeEquality.isAtLeast(taskEquality)) { + mostConcreteNodeEquality = taskEquality; + + } + + if ((requiredEqualityLevel != null) + && (mostConcreteNodeEquality + .isAtLeast(requiredEqualityLevel))) { + // if we found one child of the selection that is as equal + // as required, then + // we can consider the selection to be sufficiently equal to + // the other task. + // So we break up checking further children. + break; + } + } + } + + // although the subtask may be identical to the task, we can not return + // identical, as + // the selection is not identical to the task, but at most lexically + // equal + if (mostConcreteNodeEquality == TaskEquality.IDENTICAL) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return mostConcreteNodeEquality; + } + + } + + /** + *

+ * compares two task instances with each other checking for the provided + * required level of equality. One of the task instances must be a + * selection, the other one not. If this is not the case, the method returns + * null. The returned equality level is at most lexical equality as the + * selection can not be identical to something not being a selection. + *

+ * + * @param taskInstance1 + * the first task instance to be compared + * @param taskInstance2 + * the second task instance to be compared + * @param requiredEqualityLevel + * the equality level to be checked for + * + * @return the determined equality. + */ + private TaskEquality getEquality(ITaskInstance taskInstance1, + ITaskInstance taskInstance2, TaskEquality requiredEqualityLevel) { + ISelectionInstance selection = null; + ITaskInstance task = null; + + if (taskInstance1 instanceof ISelectionInstance) { + if (taskInstance2 instanceof ISelectionInstance) { + // the rule is not responsible for two selections + return null; + } + + selection = (ISelectionInstance) taskInstance1; + task = taskInstance2; + } else if (taskInstance2 instanceof ISelectionInstance) { + if (taskInstance1 instanceof ISelectionInstance) { + // the rule is not responsible for two selections + return null; + } + + selection = (ISelectionInstance) taskInstance2; + task = taskInstance1; + } else { + return null; + } + + // now, that we found the selection and the task, lets compare the child + // of the selection + // with the task. + final ITaskInstance child = selection.getChild(); + + if (child == null) { + return null; + } + + final TaskEquality taskEquality = callRuleManager(child, task, + requiredEqualityLevel); + + // although the subtask may be identical to the task, we can not return + // identical, as + // the selection is not identical to the task, but at most lexically + // equal + if (taskEquality == TaskEquality.IDENTICAL) { + return TaskEquality.LEXICALLY_EQUAL; + } else { + return taskEquality; + } + + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITask, ITask) + */ + @Override + public boolean isApplicable(ITask task1, ITask task2) { + return ((task1 instanceof ISelection) && (!(task2 instanceof ISelection))) + || ((task2 instanceof ISelection) && (!(task1 instanceof ISelection))); + } + + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) + */ + @Override + public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { + return isApplicable(instance1.getTask(), instance2.getTask()); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskComparisonRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskComparisonRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskComparisonRule.java (revision 1733) @@ -20,6 +20,7 @@ /** *

- * A task comparison rule is used by the {@link TaskEqualityRuleManager} to compare tasks and - * task instances with each other. It provides several methods to be called for a comparison. + * A task comparison rule is used by the {@link TaskEqualityRuleManager} to + * compare tasks and task instances with each other. It provides several methods + * to be called for a comparison. *

* @@ -29,127 +30,151 @@ public interface TaskComparisonRule { - /** - *

- * checks if the rule is applicable for comparing the two provided tasks - *

- * - * @param task1 the first task to compare - * @param task2 the second task to compare - * - * @return true, if the rule is applicable, false else - */ - public boolean isApplicable(ITask task1, ITask task2); + /** + *

+ * checks, if the provided tasks are lexically equal + *

+ * + * @param task1 + * the first task to compare + * @param task2 + * the second task to compare + * + * @return true, if the tasks are equal, false else + */ + public boolean areLexicallyEqual(ITask task1, ITask task2); - /** - *

- * checks, if the provided tasks are lexically equal - *

- * - * @param task1 the first task to compare - * @param task2 the second task to compare - * - * @return true, if the tasks are equal, false else - */ - public boolean areLexicallyEqual(ITask task1, ITask task2); + /** + *

+ * checks, if the provided task instances are lexically equal + *

+ * + * @param instance1 + * the first task instance to compare + * @param instance2 + * the second task instance to compare + * + * @return true, if the tasks are equal, false else + */ + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2); - /** - *

- * checks, if the provided tasks are syntactically equal - *

- * - * @param task1 the first task to compare - * @param task2 the second task to compare - * - * @return true, if the tasks are equal, false else - */ - public boolean areSyntacticallyEqual(ITask task1, ITask task2); + /** + *

+ * checks, if the provided tasks are semantically equal + *

+ * + * @param task1 + * the first task to compare + * @param task2 + * the second task to compare + * + * @return true, if the tasks are equal, false else + */ + public boolean areSemanticallyEqual(ITask task1, ITask task2); - /** - *

- * checks, if the provided tasks are semantically equal - *

- * - * @param task1 the first task to compare - * @param task2 the second task to compare - * - * @return true, if the tasks are equal, false else - */ - public boolean areSemanticallyEqual(ITask task1, ITask task2); + /** + *

+ * checks, if the provided task instances are semantically equal + *

+ * + * @param instance1 + * the first task instance to compare + * @param instance2 + * the second task instance to compare + * + * @return true, if the tasks are equal, false else + */ + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2); - /** - *

- * compares two tasks with each other. The result of the method is either a task equality or - * null. If it is null, it means, that the rule is not able to correctly compare the two given - * tasks - *

- * - * @param task1 the first task to compare - * @param task2 the second task to compare - * - * @return as described - */ - public TaskEquality compare(ITask task1, ITask task2); + /** + *

+ * checks, if the provided tasks are syntactically equal + *

+ * + * @param task1 + * the first task to compare + * @param task2 + * the second task to compare + * + * @return true, if the tasks are equal, false else + */ + public boolean areSyntacticallyEqual(ITask task1, ITask task2); - /** - *

- * checks if the rule is applicable for comparing the two provided task instances - *

- * - * @param instance1 the first task instance to compare - * @param instance2 the second task instance to compare - * - * @return true, if the rule is applicable, false else - */ - public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2); + /** + *

+ * checks, if the provided task instances are syntactically equal + *

+ * + * @param instance1 + * the first task instance to compare + * @param instance2 + * the second task instance to compare + * + * @return true, if the tasks are equal, false else + */ + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2); - /** - *

- * checks, if the provided task instances are lexically equal - *

- * - * @param instance1 the first task instance to compare - * @param instance2 the second task instance to compare - * - * @return true, if the tasks are equal, false else - */ - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2); + /** + *

+ * compares two tasks with each other. The result of the method is either a + * task equality or null. If it is null, it means, that the rule is not able + * to correctly compare the two given tasks + *

+ * + * @param task1 + * the first task to compare + * @param task2 + * the second task to compare + * + * @return as described + */ + public TaskEquality compare(ITask task1, ITask task2); - /** - *

- * checks, if the provided task instances are syntactically equal - *

- * - * @param instance1 the first task instance to compare - * @param instance2 the second task instance to compare - * - * @return true, if the tasks are equal, false else - */ - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2); + /** + *

+ * compares two task instances with each other. The result of the method is + * either a task instance equality or null. If it is null, it means, that + * the rule is not able to correctly compare the two given task instances + *

+ * + * @param instance1 + * the first task instance to compare + * @param instance2 + * the second task instance to compare + * + * @return as described + */ + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2); - /** - *

- * checks, if the provided task instances are semantically equal - *

- * - * @param instance1 the first task instance to compare - * @param instance2 the second task instance to compare - * - * @return true, if the tasks are equal, false else - */ - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2); + /** + *

+ * checks if the rule is applicable for comparing the two provided tasks + *

+ * + * @param task1 + * the first task to compare + * @param task2 + * the second task to compare + * + * @return true, if the rule is applicable, false else + */ + public boolean isApplicable(ITask task1, ITask task2); - /** - *

- * compares two task instances with each other. The result of the method is either a task - * instance equality or null. If it is null, it means, that the rule is not able to correctly - * compare the two given task instances - *

- * - * @param instance1 the first task instance to compare - * @param instance2 the second task instance to compare - * - * @return as described - */ - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2); + /** + *

+ * checks if the rule is applicable for comparing the two provided task + * instances + *

+ * + * @param instance1 + * the first task instance to compare + * @param instance2 + * the second task instance to compare + * + * @return true, if the rule is applicable, false else + */ + public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskEquality.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskEquality.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskEquality.java (revision 1733) @@ -17,37 +17,44 @@ /** *

- * A task equality denotes, how equal two tasks are. There are different equality levels - * which are similar to the usual design levels of GUI design. These levels are + * A task equality denotes, how equal two tasks are. There are different + * equality levels which are similar to the usual design levels of GUI design. + * These levels are *

    - *
  • conceptual design: defines the concepts to be edited using a GUI
    • - *
  • semantical design: defines the possible functions for editing the concepts
    • - *
  • syntactical design: defines, which steps are needed to execute the functions
    • - *
  • lexical design: defines on the key stroke level, how the steps for executing a function - * can be performed
    • + *
  • conceptual design: defines the concepts to be edited using a GUI
    • + *
  • semantical design: defines the possible functions for editing the + * concepts
    • + *
  • syntactical design: defines, which steps are needed to execute the + * functions
    • + *
  • lexical design: defines on the key stroke level, how the steps for + * executing a function can be performed
    • *
- * It is not possible to compare two tasks conceptually. But the other design levels can be - * identified and compared. + * It is not possible to compare two tasks conceptually. But the other design + * levels can be identified and compared. *

*

- * Tasks can be identical. This is the case if in the java virtual machine, their comparison - * using the == operator or the equals method return true. + * Tasks can be identical. This is the case if in the java virtual machine, + * their comparison using the == operator or the equals method + * return true. *

*

- * Tasks are lexically equal, if they represent the same events on a key stroke level to be - * carried out to execute the task. Identical tasks are also syntactically equal. + * Tasks are lexically equal, if they represent the same events on a key stroke + * level to be carried out to execute the task. Identical tasks are also + * syntactically equal. *

*

- * Nodes are syntactically equal, if they differ in their events on key stroke level, but the - * syntactical result is the same. For example, entering the text "hello" into a text field can - * be done by entering the letters in their correct order, but also by copying the text into the - * text field. The syntactical result is the same: The text "hello" was entered. But the tasks - * lexically differ because the events on key stroke level are different. On the other hand, - * lexically equal tasks are also syntactically equal. + * Nodes are syntactically equal, if they differ in their events on key stroke + * level, but the syntactical result is the same. For example, entering the text + * "hello" into a text field can be done by entering the letters in their + * correct order, but also by copying the text into the text field. The + * syntactical result is the same: The text "hello" was entered. But the tasks + * lexically differ because the events on key stroke level are different. On the + * other hand, lexically equal tasks are also syntactically equal. *

*

- * Tasks are semantically equal, if they execute the same function for editing the concepts. An - * example are a click on a button and a short cut, both executing the same function. These tasks - * are syntactically and, therefore, also lexically different, but semantically equal. - * Syntactically equal tasks are always also semantically equal. + * Tasks are semantically equal, if they execute the same function for editing + * the concepts. An example are a click on a button and a short cut, both + * executing the same function. These tasks are syntactically and, therefore, + * also lexically different, but semantically equal. Syntactically equal tasks + * are always also semantically equal. *

* @@ -56,73 +63,63 @@ */ public enum TaskEquality { - IDENTICAL, - LEXICALLY_EQUAL, - SYNTACTICALLY_EQUAL, - SEMANTICALLY_EQUAL, - UNEQUAL; + IDENTICAL, LEXICALLY_EQUAL, SYNTACTICALLY_EQUAL, SEMANTICALLY_EQUAL, UNEQUAL; - /** - *

- * Checks for the current task equality, if it is at least identical to the - * provided one or even more concrete. As an example, the task equality identical also - * indicates, that the tasks are e.g. lexically, syntactically and semantically equal. - * Therefore, the method called on IDENTICAL with SEMANTICALLY_EQUAL - * as parameter will return true. If this method is called on SYNTACTICALLY_EQUAL - * with the parameter IDENTICAL instead, it returns false; - *

- * - * @param taskEquality the task equality to compare with. - * - * @return as described - */ - public boolean isAtLeast(TaskEquality taskEquality) - { - switch (taskEquality) { - case IDENTICAL: - return - (this == IDENTICAL); - case LEXICALLY_EQUAL: - return - (this == IDENTICAL) || - (this == LEXICALLY_EQUAL); - case SYNTACTICALLY_EQUAL: - return - (this == IDENTICAL) || - (this == LEXICALLY_EQUAL) || - (this == SYNTACTICALLY_EQUAL); - case SEMANTICALLY_EQUAL: - return - (this == IDENTICAL) || - (this == LEXICALLY_EQUAL) || - (this == SYNTACTICALLY_EQUAL) || - (this == SEMANTICALLY_EQUAL); - case UNEQUAL: - return - (this == UNEQUAL); - default : - return false; - } - } + /** + *

+ * returns the common denominator of this task equality and the provided + * one. I.e. if one equality is e.g. syntactical and the other one only + * semantical, then semantical is returned. + *

+ * + * @param otherEquality + * the equality, to compare this with + * + * @return as described + */ + public TaskEquality getCommonDenominator(TaskEquality otherEquality) { + if (this.isAtLeast(otherEquality)) { + return otherEquality; + } else if (otherEquality.isAtLeast(this)) { + return this; + } else { + return TaskEquality.UNEQUAL; + } + } - /** - *

- * returns the common denominator of this task equality and the provided one. I.e. if one - * equality is e.g. syntactical and the other one only semantical, then semantical is returned. - *

- * - * @param otherEquality the equality, to compare this with - * - * @return as described - */ - public TaskEquality getCommonDenominator(TaskEquality otherEquality) { - if (this.isAtLeast(otherEquality)) { - return otherEquality; - } - else if (otherEquality.isAtLeast(this)) { - return this; - } - else { - return TaskEquality.UNEQUAL; - } - } + /** + *

+ * Checks for the current task equality, if it is at least identical to the + * provided one or even more concrete. As an example, the task equality + * identical also indicates, that the tasks are e.g. lexically, + * syntactically and semantically equal. Therefore, the method called on + * IDENTICAL with SEMANTICALLY_EQUAL as parameter + * will return true. If this method is called on + * SYNTACTICALLY_EQUAL with the parameter + * IDENTICAL instead, it returns false; + *

+ * + * @param taskEquality + * the task equality to compare with. + * + * @return as described + */ + public boolean isAtLeast(TaskEquality taskEquality) { + switch (taskEquality) { + case IDENTICAL: + return (this == IDENTICAL); + case LEXICALLY_EQUAL: + return (this == IDENTICAL) || (this == LEXICALLY_EQUAL); + case SYNTACTICALLY_EQUAL: + return (this == IDENTICAL) || (this == LEXICALLY_EQUAL) + || (this == SYNTACTICALLY_EQUAL); + case SEMANTICALLY_EQUAL: + return (this == IDENTICAL) || (this == LEXICALLY_EQUAL) + || (this == SYNTACTICALLY_EQUAL) + || (this == SEMANTICALLY_EQUAL); + case UNEQUAL: + return (this == UNEQUAL); + default: + return false; + } + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskEqualityRuleManager.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskEqualityRuleManager.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskEqualityRuleManager.java (revision 1733) @@ -23,8 +23,9 @@ /** *

- * The task equality rule manager is capable of comparing tasks and task instances based on its - * internal list of comparison rules. These rules are asked for comparing the two provided tasks or - * task instance. If a rule returns a task equality other than null, this equality is returned. - * Otherwise the next rule is asked. + * The task equality rule manager is capable of comparing tasks and task + * instances based on its internal list of comparison rules. These rules are + * asked for comparing the two provided tasks or task instance. If a rule + * returns a task equality other than null, this equality is returned. Otherwise + * the next rule is asked. *

* @@ -32,444 +33,497 @@ */ public class TaskEqualityRuleManager { - - /** - *

- * the singleton instance of this class - *

- */ - private static final TaskEqualityRuleManager instance = new TaskEqualityRuleManager(); - - /** - *

- * the rules that can be used for comparing tasks - *

- */ - private List mRuleIndex = null; - - /** - *

- * initializes the task equality rule manager by filling the internal list of comparison rules. - *

- */ - private TaskEqualityRuleManager() { - mRuleIndex = new ArrayList(); - mRuleIndex.add(new TaskIdentityRule()); - mRuleIndex.add(new GUIEventTaskComparisonRule()); - mRuleIndex.add(new EventTaskComparisonRule()); - mRuleIndex.add(new IterationComparisonRule()); - mRuleIndex.add(new SequenceComparisonRule()); - mRuleIndex.add(new SelectionComparisonRule()); - mRuleIndex.add(new TaskAndIterationComparisonRule()); - mRuleIndex.add(new TaskAndSelectionComparisonRule()); - } - - - /** - *

- * returns the singleton instance of this class - *

- * - * @return as described - */ - public static TaskEqualityRuleManager getInstance() { - return instance; - } - - /** - *

- * this method performs a comparison of the two provided tasks. It iterates its internal - * comparison rules. If the first rule returns a task equality other than null, - * this equality is returned. Otherwise the next rule is tried. If no rule returns an equality - * NodeEquality.UNEQUAL is returned. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public TaskEquality compare(ITask task1, ITask task2) - throws IllegalStateException - { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - // LOG.info("checking for equality of " + task1 + " and " + task2); - TaskEquality taskEquality = null; - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(task1, task2)) { - taskEquality = rule.compare(task1, task2); - if (taskEquality != null) { - // LOG.warning("used rule " + rule + " for equality check"); - return taskEquality; - } - } - } - - // LOG.warning("no rule could be applied --> handling tasks as unequal"); - - return TaskEquality.UNEQUAL; - } - - /** - *

- * this method two tasks with respect to the fiven equality level and returns true, if this - * level is given. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * @param equalityLevel the level of equality to be checked for - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areAtLeastEqual(ITask task1, ITask task2, TaskEquality equalityLevel) { - if (equalityLevel == null) { - throw new IllegalArgumentException("required equality level must not be null"); - } - - switch (equalityLevel) { - case IDENTICAL: - return areIdentical(task1, task2); - case LEXICALLY_EQUAL: - return areLexicallyEqual(task1, task2); - case SYNTACTICALLY_EQUAL: - return areSyntacticallyEqual(task1, task2); - case SEMANTICALLY_EQUAL: - return areSemanticallyEqual(task1, task2); - case UNEQUAL: - return !areSemanticallyEqual(task1, task2); - default: - throw new IllegalArgumentException("unknown required equality: " + equalityLevel); - } - } - - /** - *

- * this method checks if the two given tasks are identical. For this, it iterates its internal - * comparison rules. If the first rule returns true, than this method returns true as well. - * If no rule returns true, this method returns false. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areIdentical(ITask task1, ITask task2) { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(task1, task2) && rule.areLexicallyEqual(task1, task2)) { - return true; - } - } - - return false; - } - - /** - *

- * this method checks if the two given tasks are lexically equal. For this, it iterates its - * internal comparison rules. If the first rule returns true, than this method returns true - * as well. If no rule returns true, this method returns false. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areLexicallyEqual(ITask task1, ITask task2) { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(task1, task2) && rule.areLexicallyEqual(task1, task2)) { - return true; - } - } - - return false; - } - - /** - *

- * this method checks if the two given tasks are syntactically equal. For this, it iterates its - * internal comparison rules. If the first rule returns true, than this method returns true - * as well. If no rule returns true, this method returns false. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areSyntacticallyEqual(ITask task1, ITask task2) { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(task1, task2) && rule.areSyntacticallyEqual(task1, task2)) { - return true; - } - } - - return false; - } - - /** - *

- * this method checks if the two given tasks are semantically equal. For this, it iterates its - * internal comparison rules. If the first rule returns true, than this method returns true - * as well. If no rule returns true, this method returns false. - *

- * - * @param task1 the first task to be compared - * @param task2 the second task to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areSemanticallyEqual(ITask task1, ITask task2) { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(task1, task2) && rule.areSemanticallyEqual(task1, task2)) { - return true; - } - } - - return false; - } - - /** - *

- * this method performs a comparison of the two provided task instances. It iterates its - * internal comparison rules. If the first rule returns a task instance equality other than - * null, this equality is returned. Otherwise the next rule is tried. If no rule returns an - * equality TaskEquality.UNEQUAL is returned. - *

- * - * @param instance1 the first task instance to be compared - * @param instance2 the second task instance to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) - throws IllegalStateException - { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - // LOG.info("checking for equality of " + instance1 + " and " + instance2); - TaskEquality instanceEquality = null; - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(instance1, instance2)) { - instanceEquality = rule.compare(instance1, instance2); - if (instanceEquality != null) { - // LOG.warning("used rule " + rule + " for equality check"); - return instanceEquality; - } - } - } - - // LOG.warning("no rule could be applied --> handling tasks as unequal"); - - return TaskEquality.UNEQUAL; - } - - /** - *

- * this method compares two task instances with respect to the given equality level and returns - * true, if this level is given. - *

- * - * @param instance1 the first task instance to be compared - * @param instance2 the second task instance to be compared - * @param equalityLevel the level of equality to be checked for - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areAtLeastEqual(ITaskInstance instance1, - ITaskInstance instance2, - TaskEquality equalityLevel) - { - if (equalityLevel == null) { - throw new IllegalArgumentException("required equality level must not be null"); - } - - switch (equalityLevel) { - case IDENTICAL: - return areIdentical(instance1, instance2); - case LEXICALLY_EQUAL: - return areLexicallyEqual(instance1, instance2); - case SYNTACTICALLY_EQUAL: - return areSyntacticallyEqual(instance1, instance2); - case SEMANTICALLY_EQUAL: - return areSemanticallyEqual(instance1, instance2); - case UNEQUAL: - return !areSemanticallyEqual(instance1, instance2); - default: - throw new IllegalArgumentException("unknown required equality: " + equalityLevel); - } - } - - /** - *

- * this method checks if the two given task instances are identical. For this, it iterates its - * internal comparison rules. If the first rule returns true, than this method returns true - * as well. If no rule returns true, this method returns false. - *

- * - * @param instance1 the first task instance to be compared - * @param instance2 the second task instance to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areIdentical(ITaskInstance instance1, ITaskInstance instance2) { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(instance1, instance2) && - rule.areLexicallyEqual(instance1, instance2)) - { - return true; - } - } - - return false; - } - - /** - *

- * this method checks if the two given task instances are lexically equal. For this, it - * iterates its internal comparison rules. If the first rule returns true, than this method - * returns true, as well. If no rule returns true, this method returns false. - *

- * - * @param instance1 the first task instance to be compared - * @param instance2 the second task instance to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(instance1, instance2) && - rule.areLexicallyEqual(instance1, instance2)) - { - return true; - } - } - - return false; - } - - /** - *

- * this method checks if the two given task instances are syntactically equal. For this, it - * iterates its internal comparison rules. If the first rule returns true, than this method - * returns true, as well. If no rule returns true, this method returns false. - *

- * - * @param instance1 the first task instance to be compared - * @param instance2 the second task instance to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(instance1, instance2) && - rule.areSyntacticallyEqual(instance1, instance2)) - { - return true; - } - } - - return false; - } - - /** - *

- * this method checks if the two given task instances are semantically equal. For this, it - * iterates its internal comparison rules. If the first rule returns true, than this method - * returns true, as well. If no rule returns true, this method returns false. - *

- * - * @param instance1 the first task instance to be compared - * @param instance2 the second task instance to be compared - * - * @return as described - * - * @throws IllegalStateException in the case, the {@link #init()} method was not called on the - * manager before a call to this method. - */ - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - if (mRuleIndex == null) { - throw new IllegalStateException("not initialized"); - } - - for (TaskComparisonRule rule : mRuleIndex) { - if (rule.isApplicable(instance1, instance2) && - rule.areSemanticallyEqual(instance1, instance2)) - { - return true; - } - } - - return false; - } + + /** + *

+ * returns the singleton instance of this class + *

+ * + * @return as described + */ + public static TaskEqualityRuleManager getInstance() { + return instance; + } + + /** + *

+ * the singleton instance of this class + *

+ */ + private static final TaskEqualityRuleManager instance = new TaskEqualityRuleManager(); + + /** + *

+ * the rules that can be used for comparing tasks + *

+ */ + private List mRuleIndex = null; + + /** + *

+ * initializes the task equality rule manager by filling the internal list + * of comparison rules. + *

+ */ + private TaskEqualityRuleManager() { + mRuleIndex = new ArrayList(); + mRuleIndex.add(new TaskIdentityRule()); + mRuleIndex.add(new GUIEventTaskComparisonRule()); + mRuleIndex.add(new EventTaskComparisonRule()); + mRuleIndex.add(new IterationComparisonRule()); + mRuleIndex.add(new SequenceComparisonRule()); + mRuleIndex.add(new SelectionComparisonRule()); + mRuleIndex.add(new TaskAndIterationComparisonRule()); + mRuleIndex.add(new TaskAndSelectionComparisonRule()); + } + + /** + *

+ * this method two tasks with respect to the fiven equality level and + * returns true, if this level is given. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * @param equalityLevel + * the level of equality to be checked for + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areAtLeastEqual(ITask task1, ITask task2, + TaskEquality equalityLevel) { + if (equalityLevel == null) { + throw new IllegalArgumentException( + "required equality level must not be null"); + } + + switch (equalityLevel) { + case IDENTICAL: + return areIdentical(task1, task2); + case LEXICALLY_EQUAL: + return areLexicallyEqual(task1, task2); + case SYNTACTICALLY_EQUAL: + return areSyntacticallyEqual(task1, task2); + case SEMANTICALLY_EQUAL: + return areSemanticallyEqual(task1, task2); + case UNEQUAL: + return !areSemanticallyEqual(task1, task2); + default: + throw new IllegalArgumentException("unknown required equality: " + + equalityLevel); + } + } + + /** + *

+ * this method compares two task instances with respect to the given + * equality level and returns true, if this level is given. + *

+ * + * @param instance1 + * the first task instance to be compared + * @param instance2 + * the second task instance to be compared + * @param equalityLevel + * the level of equality to be checked for + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areAtLeastEqual(ITaskInstance instance1, + ITaskInstance instance2, TaskEquality equalityLevel) { + if (equalityLevel == null) { + throw new IllegalArgumentException( + "required equality level must not be null"); + } + + switch (equalityLevel) { + case IDENTICAL: + return areIdentical(instance1, instance2); + case LEXICALLY_EQUAL: + return areLexicallyEqual(instance1, instance2); + case SYNTACTICALLY_EQUAL: + return areSyntacticallyEqual(instance1, instance2); + case SEMANTICALLY_EQUAL: + return areSemanticallyEqual(instance1, instance2); + case UNEQUAL: + return !areSemanticallyEqual(instance1, instance2); + default: + throw new IllegalArgumentException("unknown required equality: " + + equalityLevel); + } + } + + /** + *

+ * this method checks if the two given tasks are identical. For this, it + * iterates its internal comparison rules. If the first rule returns true, + * than this method returns true as well. If no rule returns true, this + * method returns false. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areIdentical(ITask task1, ITask task2) { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(task1, task2) + && rule.areLexicallyEqual(task1, task2)) { + return true; + } + } + + return false; + } + + /** + *

+ * this method checks if the two given task instances are identical. For + * this, it iterates its internal comparison rules. If the first rule + * returns true, than this method returns true as well. If no rule returns + * true, this method returns false. + *

+ * + * @param instance1 + * the first task instance to be compared + * @param instance2 + * the second task instance to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areIdentical(ITaskInstance instance1, ITaskInstance instance2) { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(instance1, instance2) + && rule.areLexicallyEqual(instance1, instance2)) { + return true; + } + } + + return false; + } + + /** + *

+ * this method checks if the two given tasks are lexically equal. For this, + * it iterates its internal comparison rules. If the first rule returns + * true, than this method returns true as well. If no rule returns true, + * this method returns false. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areLexicallyEqual(ITask task1, ITask task2) { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(task1, task2) + && rule.areLexicallyEqual(task1, task2)) { + return true; + } + } + + return false; + } + + /** + *

+ * this method checks if the two given task instances are lexically equal. + * For this, it iterates its internal comparison rules. If the first rule + * returns true, than this method returns true, as well. If no rule returns + * true, this method returns false. + *

+ * + * @param instance1 + * the first task instance to be compared + * @param instance2 + * the second task instance to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(instance1, instance2) + && rule.areLexicallyEqual(instance1, instance2)) { + return true; + } + } + + return false; + } + + /** + *

+ * this method checks if the two given tasks are semantically equal. For + * this, it iterates its internal comparison rules. If the first rule + * returns true, than this method returns true as well. If no rule returns + * true, this method returns false. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areSemanticallyEqual(ITask task1, ITask task2) { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(task1, task2) + && rule.areSemanticallyEqual(task1, task2)) { + return true; + } + } + + return false; + } + + /** + *

+ * this method checks if the two given task instances are semantically + * equal. For this, it iterates its internal comparison rules. If the first + * rule returns true, than this method returns true, as well. If no rule + * returns true, this method returns false. + *

+ * + * @param instance1 + * the first task instance to be compared + * @param instance2 + * the second task instance to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(instance1, instance2) + && rule.areSemanticallyEqual(instance1, instance2)) { + return true; + } + } + + return false; + } + + /** + *

+ * this method checks if the two given tasks are syntactically equal. For + * this, it iterates its internal comparison rules. If the first rule + * returns true, than this method returns true as well. If no rule returns + * true, this method returns false. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areSyntacticallyEqual(ITask task1, ITask task2) { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(task1, task2) + && rule.areSyntacticallyEqual(task1, task2)) { + return true; + } + } + + return false; + } + + /** + *

+ * this method checks if the two given task instances are syntactically + * equal. For this, it iterates its internal comparison rules. If the first + * rule returns true, than this method returns true, as well. If no rule + * returns true, this method returns false. + *

+ * + * @param instance1 + * the first task instance to be compared + * @param instance2 + * the second task instance to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(instance1, instance2) + && rule.areSyntacticallyEqual(instance1, instance2)) { + return true; + } + } + + return false; + } + + /** + *

+ * this method performs a comparison of the two provided tasks. It iterates + * its internal comparison rules. If the first rule returns a task equality + * other than null, this equality is returned. Otherwise the next rule is + * tried. If no rule returns an equality NodeEquality.UNEQUAL + * is returned. + *

+ * + * @param task1 + * the first task to be compared + * @param task2 + * the second task to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public TaskEquality compare(ITask task1, ITask task2) + throws IllegalStateException { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + // LOG.info("checking for equality of " + task1 + " and " + task2); + TaskEquality taskEquality = null; + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(task1, task2)) { + taskEquality = rule.compare(task1, task2); + if (taskEquality != null) { + // LOG.warning("used rule " + rule + " for equality check"); + return taskEquality; + } + } + } + + // LOG.warning("no rule could be applied --> handling tasks as unequal"); + + return TaskEquality.UNEQUAL; + } + + /** + *

+ * this method performs a comparison of the two provided task instances. It + * iterates its internal comparison rules. If the first rule returns a task + * instance equality other than null, this equality is returned. Otherwise + * the next rule is tried. If no rule returns an equality + * TaskEquality.UNEQUAL is returned. + *

+ * + * @param instance1 + * the first task instance to be compared + * @param instance2 + * the second task instance to be compared + * + * @return as described + * + * @throws IllegalStateException + * in the case, the {@link #init()} method was not called on the + * manager before a call to this method. + */ + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) + throws IllegalStateException { + if (mRuleIndex == null) { + throw new IllegalStateException("not initialized"); + } + + // LOG.info("checking for equality of " + instance1 + " and " + + // instance2); + TaskEquality instanceEquality = null; + + for (final TaskComparisonRule rule : mRuleIndex) { + if (rule.isApplicable(instance1, instance2)) { + instanceEquality = rule.compare(instance1, instance2); + if (instanceEquality != null) { + // LOG.warning("used rule " + rule + " for equality check"); + return instanceEquality; + } + } + } + + // LOG.warning("no rule could be applied --> handling tasks as unequal"); + + return TaskEquality.UNEQUAL; + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskIdentityRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskIdentityRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/taskequality/TaskIdentityRule.java (revision 1733) @@ -20,7 +20,7 @@ /** *

- * This comparison rule returns TaskEquality.IDENTICAL if the comparison of the two - * tasks using the == operator returns true. Else it returns null to denote, that - * it can not compare the tasks. + * This comparison rule returns TaskEquality.IDENTICAL if the + * comparison of the two tasks using the == operator returns true. + * Else it returns null to denote, that it can not compare the tasks. *

* @@ -30,93 +30,116 @@ public class TaskIdentityRule implements TaskComparisonRule { - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITask, ITask) - */ - @Override - public boolean isApplicable(ITask task1, ITask task2) { - return (task1 == task2); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) + */ + @Override + public boolean areLexicallyEqual(ITask task1, ITask task2) { + return (task1 == task2); + } - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITask, ITask) - */ - @Override - public boolean areLexicallyEqual(ITask task1, ITask task2) { - return (task1 == task2); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) + */ + @Override + public boolean areLexicallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + return (instance1.getTask() == instance2.getTask()); + } - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) - */ - @Override - public boolean areSyntacticallyEqual(ITask task1, ITask task2) { - return (task1 == task2); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) + */ + @Override + public boolean areSemanticallyEqual(ITask task1, ITask task2) { + return (task1 == task2); + } - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITask, ITask) - */ - @Override - public boolean areSemanticallyEqual(ITask task1, ITask task2) { - return (task1 == task2); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSemanticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + return (instance1.getTask() == instance2.getTask()); + } - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITask, ITask) - */ - @Override - public TaskEquality compare(ITask task1, ITask task2) { - if (isApplicable(task1, task2)) { - return TaskEquality.IDENTICAL; - } - else { - return null; - } - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITask, ITask) + */ + @Override + public boolean areSyntacticallyEqual(ITask task1, ITask task2) { + return (task1 == task2); + } - /* (non-Javadoc) - * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) - */ - @Override - public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { - return (instance1.getTask() == instance2.getTask()); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, + * ITaskInstance) + */ + @Override + public boolean areSyntacticallyEqual(ITaskInstance instance1, + ITaskInstance instance2) { + return (instance1.getTask() == instance2.getTask()); + } - /* (non-Javadoc) - * @see TaskComparisonRule#areLexicallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areLexicallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - return (instance1.getTask() == instance2.getTask()); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITask, ITask) + */ + @Override + public TaskEquality compare(ITask task1, ITask task2) { + if (isApplicable(task1, task2)) { + return TaskEquality.IDENTICAL; + } else { + return null; + } + } - /* (non-Javadoc) - * @see TaskComparisonRule#areSyntacticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSyntacticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - return (instance1.getTask() == instance2.getTask()); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) + */ + @Override + public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { + if (isApplicable(instance1, instance2)) { + return TaskEquality.IDENTICAL; + } else { + return null; + } + } - /* (non-Javadoc) - * @see TaskComparisonRule#areSemanticallyEqual(ITaskInstance, ITaskInstance) - */ - @Override - public boolean areSemanticallyEqual(ITaskInstance instance1, ITaskInstance instance2) { - return (instance1.getTask() == instance2.getTask()); - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITask, ITask) + */ + @Override + public boolean isApplicable(ITask task1, ITask task2) { + return (task1 == task2); + } - /* (non-Javadoc) - * @see TaskComparisonRule#compare(ITaskInstance, ITaskInstance) - */ - @Override - public TaskEquality compare(ITaskInstance instance1, ITaskInstance instance2) { - if (isApplicable(instance1, instance2)) { - return TaskEquality.IDENTICAL; - } - else { - return null; - } - } + /* + * (non-Javadoc) + * + * @see TaskComparisonRule#isApplicable(ITaskInstance, ITaskInstance) + */ + @Override + public boolean isApplicable(ITaskInstance instance1, ITaskInstance instance2) { + return (instance1.getTask() == instance2.getTask()); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/ISessionScopeRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/ISessionScopeRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/ISessionScopeRule.java (revision 1733) @@ -21,9 +21,10 @@ /** *

- * A session scope rule is able to detected temporal relationships between task instances of the - * sessions provided to the {@link #apply(List)} method. The rule creates temporal - * relationships between the tasks of the task instances, i.e. substructures in the task tree, if - * it detects a temporal relationship and instantiates the temporal relationships according to - * their occurrences. + * A session scope rule is able to detected temporal relationships between task + * instances of the sessions provided to the {@link #apply(List)} + * method. The rule creates temporal relationships between the tasks of the task + * instances, i.e. substructures in the task tree, if it detects a temporal + * relationship and instantiates the temporal relationships according to their + * occurrences. *

* @@ -32,17 +33,19 @@ interface ISessionScopeRule extends ITemporalRelationshipRule { - /** - *

- * Applies the rule to the given sessions. The returned rule application result is null, if the - * rule can not be applied, i.e. it does not detect a temporal relationship. It returns a rule - * application result with a status {@link RuleApplicationStatus#RULE_APPLICATION_FINISHED} if - * the rule was applied. The result contains all newly created tasks and task instances. - *

- * - * @param sessions the session on which the rule shall be applied - * - * @return the rule application result as described. - */ - RuleApplicationResult apply(List sessions); + /** + *

+ * Applies the rule to the given sessions. The returned rule application + * result is null, if the rule can not be applied, i.e. it does not detect a + * temporal relationship. It returns a rule application result with a status + * {@link RuleApplicationStatus#RULE_APPLICATION_FINISHED} if the rule was + * applied. The result contains all newly created tasks and task instances. + *

+ * + * @param sessions + * the session on which the rule shall be applied + * + * @return the rule application result as described. + */ + RuleApplicationResult apply(List sessions); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/ITaskInstanceScopeRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/ITaskInstanceScopeRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/ITaskInstanceScopeRule.java (revision 1733) @@ -19,8 +19,9 @@ /** *

- * a task instance scope rule is able to detected temporal relationships between the children of - * a task instance provided to the {@link #apply(ITaskInstance)} method. A rule creates temporal - * relationships between the task instances, i.e. substructures in the task tree, if - * it detects a temporal relationship and instantiates the temporal relationships accordingly. + * a task instance scope rule is able to detected temporal relationships between + * the children of a task instance provided to the {@link #apply(ITaskInstance)} + * method. A rule creates temporal relationships between the task instances, + * i.e. substructures in the task tree, if it detects a temporal relationship + * and instantiates the temporal relationships accordingly. *

* @@ -29,17 +30,20 @@ interface ITaskInstanceScopeRule extends ITemporalRelationshipRule { - /** - *

- * applies the rule to the given task instance. The returned rule application result is null, - * if the rule can not be applied, i.e. it does not detect a temporal relationship. It returns a - * rule application result with a status {@link RuleApplicationStatus#RULE_APPLICATION_FINISHED} - * if the rule was applied. The result contains all newly created parent tasks and task instances. - *

- * - * @param taskInstance the task instances to apply the rule on - * - * @return the rule application result as described. - */ - RuleApplicationResult apply(ITaskInstance taskInstance); - + /** + *

+ * applies the rule to the given task instance. The returned rule + * application result is null, if the rule can not be applied, i.e. it does + * not detect a temporal relationship. It returns a rule application result + * with a status {@link RuleApplicationStatus#RULE_APPLICATION_FINISHED} if + * the rule was applied. The result contains all newly created parent tasks + * and task instances. + *

+ * + * @param taskInstance + * the task instances to apply the rule on + * + * @return the rule application result as described. + */ + RuleApplicationResult apply(ITaskInstance taskInstance); + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/ITemporalRelationshipRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/ITemporalRelationshipRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/ITemporalRelationshipRule.java (revision 1733) @@ -17,7 +17,8 @@ /** *

- * a temporal relationship rule is the main interface for all rules applied for generating - * temporal relationships in a task tree. It is just a marker interface. More important are the - * sub interfaces {@link ISessionScopeRule} and {@link ITaskInstanceScopeRule}. + * a temporal relationship rule is the main interface for all rules applied for + * generating temporal relationships in a task tree. It is just a marker + * interface. More important are the sub interfaces {@link ISessionScopeRule} + * and {@link ITaskInstanceScopeRule}. *

* Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/RuleApplicationResult.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/RuleApplicationResult.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/RuleApplicationResult.java (revision 1733) @@ -24,7 +24,8 @@ /** *

- * The rule application result describes the result of applying a {@link ITemporalRelationshipRule}. - * It contains a {@link RuleApplicationStatus} and a list of all parent task instances and tasks - * that were created during a rule application. See the description of + * The rule application result describes the result of applying a + * {@link ITemporalRelationshipRule}. It contains a + * {@link RuleApplicationStatus} and a list of all parent task instances and + * tasks that were created during a rule application. See the description of * {@link ITemporalRelationshipRule} for more details. *

@@ -34,5 +35,4 @@ class RuleApplicationResult implements Serializable { - /** * @@ -41,74 +41,75 @@ /** */ - private RuleApplicationStatus status = RuleApplicationStatus.NOT_APPLIED; + private RuleApplicationStatus status = RuleApplicationStatus.NOT_APPLIED; - /** */ - private List newParentTasks = new ArrayList(); + /** */ + private final List newParentTasks = new ArrayList(); - /** */ - private List newParentInstances = new ArrayList(); + /** */ + private final List newParentInstances = new ArrayList(); - /** - *

- * create a rule application result with a status {@link RuleApplicationStatus#RULE_NOT_APPLIED} - *

- */ - RuleApplicationResult() { - // this is the default indicating nothing so far - } + /** + *

+ * create a rule application result with a status + * {@link RuleApplicationStatus#RULE_NOT_APPLIED} + *

+ */ + RuleApplicationResult() { + // this is the default indicating nothing so far + } - /** - *

- * set the rule application status - *

- */ - void setRuleApplicationStatus(RuleApplicationStatus status) { - this.status = status; - } + /** + *

+ * add a further parent task created during the rule application + *

+ */ + void addNewlyCreatedTask(ITask newParent) { + newParentTasks.add(newParent); + } - /** - *

- * return the rule application status - *

- */ - RuleApplicationStatus getRuleApplicationStatus() { - return status; - } + /** + *

+ * add a further parent task instance created during the rule application + *

+ */ + void addNewlyCreatedTaskInstance(ITaskInstance newParent) { + newParentInstances.add(newParent); + } - /** - *

- * add a further parent task created during the rule application - *

- */ - void addNewlyCreatedTask(ITask newParent) { - newParentTasks.add(newParent); - } + /** + *

+ * return all parent task instances created during the rule application + *

+ */ + List getNewlyCreatedTaskInstances() { + return newParentInstances; + } - /** - *

- * return all parent tasks created during the rule application - *

- */ - List getNewlyCreatedTasks() { - return newParentTasks; - } + /** + *

+ * return all parent tasks created during the rule application + *

+ */ + List getNewlyCreatedTasks() { + return newParentTasks; + } - /** - *

- * add a further parent task instance created during the rule application - *

- */ - void addNewlyCreatedTaskInstance(ITaskInstance newParent) { - newParentInstances.add(newParent); - } + /** + *

+ * return the rule application status + *

+ */ + RuleApplicationStatus getRuleApplicationStatus() { + return status; + } - /** - *

- * return all parent task instances created during the rule application - *

- */ - List getNewlyCreatedTaskInstances() { - return newParentInstances; - } + /** + *

+ * set the rule application status + *

+ */ + void setRuleApplicationStatus(RuleApplicationStatus status) { + this.status = status; + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/RuleApplicationStatus.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/RuleApplicationStatus.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/RuleApplicationStatus.java (revision 1733) @@ -17,6 +17,7 @@ /** *

- * The rule application status describes the result of applying a {@link ITemporalRelationshipRule}. - * See the description of {@link ITemporalRelationshipRule} for more details. + * The rule application status describes the result of applying a + * {@link ITemporalRelationshipRule}. See the description of + * {@link ITemporalRelationshipRule} for more details. *

* @@ -24,5 +25,4 @@ */ enum RuleApplicationStatus { - FINISHED, - NOT_APPLIED; + FINISHED, NOT_APPLIED; } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/RuleUtils.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/RuleUtils.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/RuleUtils.java (revision 1733) @@ -15,6 +15,4 @@ package de.ugoe.cs.autoquest.tasktrees.temporalrelation; -import de.ugoe.cs.autoquest.tasktrees.treeifc.IIteration; -import de.ugoe.cs.autoquest.tasktrees.treeifc.IIterationInstance; import de.ugoe.cs.autoquest.tasktrees.treeifc.IMarkingTemporalRelationship; import de.ugoe.cs.autoquest.tasktrees.treeifc.IOptional; @@ -24,5 +22,4 @@ import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequence; import de.ugoe.cs.autoquest.tasktrees.treeifc.ISequenceInstance; -import de.ugoe.cs.autoquest.tasktrees.treeifc.IStructuringTemporalRelationship; import de.ugoe.cs.autoquest.tasktrees.treeifc.ITask; import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskBuilder; @@ -42,11 +39,172 @@ /** *

- * counter for generating unique ids. Starts at 0 for each new program start - *

- */ - private static int idCounter = 0; - - public static int missedOptionals = 0; - + * replaces a sub sequence for a specified range of elements in the provided + * task instances list by a sub task instance + *

+ * + * @param parent + * the list of which the range shall be replaced + * @param startIndex + * the start index of the range + * @param endIndex + * the end index of the range (inclusive) + * @param model + * the task model (required for instantiating the sub sequence) + * @param taskFactory + * the task factory used for instantiating the sub sequence + * @param taskBuilder + * the task builder to perform changes in the task structure + * + * @return the replacement for the range + * @throws + */ + static ISequenceInstance createNewSubSequenceInRange( + ITaskInstanceList parent, int startIndex, int endIndex, + ISequence model, ITaskFactory taskFactory, ITaskBuilder taskBuilder) { + final ISequenceInstance subsequence = taskFactory + .createNewTaskInstance(model); + + // TODO: Debug output + /* + * System.out.println("PRINTING MODEL: "); for (int i = 0; i < + * subsequence.getSequence().getChildren().size(); i++) { + * System.out.println(subsequence.getSequence().getChildren().get(i)); + * + * if (subsequence.getSequence().getChildren().get(i).getType() == + * "selection") { for (int j = 0; j < ((ISelection) + * subsequence.getSequence().getChildren().get(i)) + * .getChildren().size(); j++) { if(((IStructuringTemporalRelationship) + * subsequence + * .getSequence().getChildren().get(i)).getChildren().get(j).getType() + * =="sequence") { ISequence foo = (ISequence) ((ISelection) + * (subsequence + * .getSequence().getChildren().get(i))).getChildren().get(j); + * System.out.println("\t" + foo); for(int k=0; k< + * foo.getChildren().size();k++) { System.out.println("\t\t" + * +foo.getChildren().get(k)); } System.out.println(); } else{ + * System.out.println("\t" + ((ISelection) + * subsequence.getSequence().getChildren().get(i)) + * .getChildren().get(j)); } + * + * } } + * + * } System.out.println(); + */ + + // TODO: This is dirty! + missedOptionals = 0; + int modelindex = 0; + for (int i = startIndex; i <= endIndex; i++) { + + if (modelindex == model.getChildren().size()) { + break; + } + final ITask tempTask = model.getChildren().get(modelindex); + // System.out.println("Trying to add " + parent.get(startIndex) + // + " to the model instance " + tempTask); + if (tempTask.getType() == "optionality") { + + if (((IMarkingTemporalRelationship) tempTask).getMarkedTask() == parent + .get(startIndex).getTask()) { + // System.out.println("Adding OptionalInstance " + + // parent.get(startIndex) + " to " + tempTask.getType()); + final IOptionalInstance optional = taskFactory + .createNewTaskInstance((IOptional) tempTask); + taskBuilder.setChild(optional, parent.get(startIndex)); + taskBuilder.addChild(subsequence, optional); + } else { + // System.out.println("Adding Empty optional, not deleting anything from the input sequence"); + final IOptionalInstance optional = taskFactory + .createNewTaskInstance((IOptional) tempTask); + taskBuilder.addChild(subsequence, optional); + modelindex++; + missedOptionals++; + continue; + } + } else if (tempTask.getType() == "selection") { + final ISelectionInstance selection = taskFactory + .createNewTaskInstance((ISelection) tempTask); + final ISelection tmpSel = (ISelection) tempTask; + if ((tmpSel.getChildren().get(0).getType() == "sequence") + && (tmpSel.getChildren().get(1).getType() == "sequence")) { + ISequenceInstance selseq = null; + // The selection I create can just have 2 children + if (parent.get(startIndex).getTask().getId() == ((ISequence) tmpSel + .getChildren().get(0)).getChildren().get(0).getId()) { + selseq = taskFactory + .createNewTaskInstance((ISequence) tmpSel + .getChildren().get(0)); + } else if (parent.get(startIndex).getTask().getId() == ((ISequence) tmpSel + .getChildren().get(1)).getChildren().get(0).getId()) { + selseq = taskFactory + .createNewTaskInstance((ISequence) tmpSel + .getChildren().get(1)); + } else if ((parent.get(startIndex).getTask().getId() == tmpSel + .getChildren().get(0).getId()) + || (parent.get(startIndex).getTask().getId() == tmpSel + .getChildren().get(1).getId())) { + // System.out.println("Session ID: " + + // parent.get(startIndex).getTask().getId() + + // " tmpSel(0): " + tmpSel.getChildren().get(0).getId() + // + " tmpSel(1): " +tmpSel.getChildren().get(1).getId() + // ); + continue; + } + + for (int k = 0; k < selseq.getSequence().getChildren() + .size(); k++) { + // System.out.println("Trying to add " + + // parent.get(startIndex) + " to " + selseq); + taskBuilder.addChild(selseq, parent.get(startIndex)); + taskBuilder.removeTaskInstance(parent, startIndex); + i++; + // System.out.println("I:" + i); + } + // System.out.println("Trying to add " + selseq + " to " + + // tmpSel); + taskBuilder.setChild(selection, selseq); + taskBuilder.addChild(subsequence, selection); + modelindex++; + continue; + } else { + // System.out.println("Trying to adding SelectionInstance " + // + parent.get(startIndex) + " to " + tempTask); + taskBuilder.setChild(selection, parent.get(startIndex)); + taskBuilder.addChild(subsequence, selection); + } + } else if (tempTask.getType() == "sequence") { + // System.out.println("Adding SequenceInstance " + + // parent.get(startIndex) + " to " + tempTask); + taskBuilder.addChild(subsequence, parent.get(startIndex)); + } else if (tempTask.getType() == "iteration") { + // System.out.println("Adding IterationInstance " + + // parent.get(startIndex) + " to " + tempTask); + taskBuilder.addChild(subsequence, parent.get(startIndex)); + } else { + // System.out.println("Adding EventInstance " + + // parent.get(startIndex) + " to " + tempTask); + // System.out.println("Foo"); + taskBuilder.addChild(subsequence, parent.get(startIndex)); + } + taskBuilder.removeTaskInstance(parent, startIndex); + modelindex++; + } + + taskBuilder.addTaskInstance(parent, startIndex, subsequence); + + return subsequence; + } + + /** + *

+ * returns the next available id (uses the id counter) + *

+ * + * @return the next available id + */ + static synchronized String getNewId() { + return Integer.toString(idCounter++); + } + /** *

@@ -73,5 +231,5 @@ int startIndex, int endIndex, ISequence model, ITaskFactory taskFactory, ITaskBuilder taskBuilder) { - ISequenceInstance subsequence = taskFactory + final ISequenceInstance subsequence = taskFactory .createNewTaskInstance(model); @@ -83,157 +241,14 @@ } - /** - *

- * replaces a sub sequence for a specified range of elements in the provided - * task instances list by a sub task instance - *

- * - * @param parent - * the list of which the range shall be replaced - * @param startIndex - * the start index of the range - * @param endIndex - * the end index of the range (inclusive) - * @param model - * the task model (required for instantiating the sub sequence) - * @param taskFactory - * the task factory used for instantiating the sub sequence - * @param taskBuilder - * the task builder to perform changes in the task structure - * - * @return the replacement for the range - * @throws - */ - static ISequenceInstance createNewSubSequenceInRange( - ITaskInstanceList parent, int startIndex, int endIndex, - ISequence model, ITaskFactory taskFactory, ITaskBuilder taskBuilder) { - ISequenceInstance subsequence = taskFactory - .createNewTaskInstance(model); - - - // TODO: Debug output - /* - System.out.println("PRINTING MODEL: "); - for (int i = 0; i < subsequence.getSequence().getChildren().size(); i++) { - System.out.println(subsequence.getSequence().getChildren().get(i)); - - if (subsequence.getSequence().getChildren().get(i).getType() == "selection") { - for (int j = 0; j < ((ISelection) subsequence.getSequence().getChildren().get(i)) - .getChildren().size(); j++) { - if(((IStructuringTemporalRelationship) subsequence.getSequence().getChildren().get(i)).getChildren().get(j).getType() =="sequence") - { - ISequence foo = (ISequence) ((ISelection) (subsequence.getSequence().getChildren().get(i))).getChildren().get(j); - System.out.println("\t" + foo); - for(int k=0; k< foo.getChildren().size();k++) { - System.out.println("\t\t" +foo.getChildren().get(k)); - } - System.out.println(); - } - else{ - System.out.println("\t" - + ((ISelection) subsequence.getSequence().getChildren().get(i)) - .getChildren().get(j)); - } - - } - } - - } - System.out.println(); - */ - - //TODO: This is dirty! - missedOptionals=0; - int modelindex=0; - for (int i = startIndex; i <= endIndex; i++) { - - if(modelindex == model.getChildren().size()) { - break; - } - ITask tempTask = model.getChildren().get(modelindex); - //System.out.println("Trying to add " + parent.get(startIndex) - // + " to the model instance " + tempTask); - if (tempTask.getType() == "optionality") { - - if(((IMarkingTemporalRelationship) tempTask).getMarkedTask() == parent.get(startIndex).getTask()) { - //System.out.println("Adding OptionalInstance " + parent.get(startIndex) + " to " + tempTask.getType()); - IOptionalInstance optional = taskFactory.createNewTaskInstance((IOptional) tempTask); - taskBuilder.setChild(optional, parent.get(startIndex)); - taskBuilder.addChild(subsequence, optional); - } - else { - //System.out.println("Adding Empty optional, not deleting anything from the input sequence"); - IOptionalInstance optional = taskFactory.createNewTaskInstance((IOptional) tempTask); - taskBuilder.addChild(subsequence, optional); - modelindex++; - missedOptionals++; - continue; - } - } else if (tempTask.getType() == "selection") { - ISelectionInstance selection = taskFactory.createNewTaskInstance((ISelection) tempTask); - ISelection tmpSel = (ISelection)tempTask; - if(tmpSel.getChildren().get(0).getType() == "sequence" && tmpSel.getChildren().get(1).getType()=="sequence") { - ISequenceInstance selseq = null; - //The selection I create can just have 2 children - if(parent.get(startIndex).getTask().getId() == ((ISequence)tmpSel.getChildren().get(0)).getChildren().get(0).getId()) { - selseq = taskFactory.createNewTaskInstance((ISequence) tmpSel.getChildren().get(0)); - } - else if(parent.get(startIndex).getTask().getId() == ((ISequence)tmpSel.getChildren().get(1)).getChildren().get(0).getId()) { - selseq = taskFactory.createNewTaskInstance((ISequence) tmpSel.getChildren().get(1)); - } - else if(parent.get(startIndex).getTask().getId() == tmpSel.getChildren().get(0).getId() || parent.get(startIndex).getTask().getId() == tmpSel.getChildren().get(1).getId() ) { - //System.out.println("Session ID: " + parent.get(startIndex).getTask().getId() + " tmpSel(0): " + tmpSel.getChildren().get(0).getId() + " tmpSel(1): " +tmpSel.getChildren().get(1).getId() ); - continue; - } - - for (int k=0;k 100) { - if ((count % (size / 100) == 0)) { + if (((count % (size / 100)) == 0)) { // Console.traceln(Level.INFO,("Thread" + // Thread.currentThread().getName() + ": " + Math.round((float) // count/size*100))+ "%"); - System.out.println(message + " in thread" + Thread.currentThread().getName() - + ": " + Math.round((float) count / size * 100) + "%"); + System.out.println(message + " in thread" + + Thread.currentThread().getName() + ": " + + Math.round(((float) count / size) * 100) + "%"); } } else { @@ -241,21 +256,19 @@ // Thread.currentThread().getName() + ": " +Math.round((float) // count/size*100))+ "%"); - System.out.println(message + " in thread" + Thread.currentThread().getName() - + ": " + Math.round((float) count / size * 100) + "%"); + System.out.println(message + " in thread" + + Thread.currentThread().getName() + ": " + + Math.round(((float) count / size) * 100) + "%"); } } - - /** - *

- * returns the next available id (uses the id counter) - *

- * - * @return the next available id - */ - static synchronized String getNewId() { - return Integer.toString(idCounter++); - } + /** + *

+ * counter for generating unique ids. Starts at 0 for each new program start + *

+ */ + private static int idCounter = 0; + + public static int missedOptionals = 0; /** Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/SequenceForTaskDetectionRule.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/SequenceForTaskDetectionRule.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/SequenceForTaskDetectionRule.java (revision 1733) @@ -45,16 +45,18 @@ /** *

- * This class implements the major rule for creating task trees based on a set of recorded - * user sessions. For this, it first harmonizes all tasks. This eases later comparison. Then it - * searches the sessions for iterations and replaces them accordingly. Then it searches for sub - * sequences being the longest and occurring most often. For each found sub sequence, it replaces - * the occurrences by creating appropriate {@link ISequence}s. Afterwards, again searches for - * iterations and then again for sub sequences until no more replacements are done. + * This class implements the major rule for creating task trees based on a set + * of recorded user sessions. For this, it first harmonizes all tasks. This + * eases later comparison. Then it searches the sessions for iterations and + * replaces them accordingly. Then it searches for sub sequences being the + * longest and occurring most often. For each found sub sequence, it replaces + * the occurrences by creating appropriate {@link ISequence}s. Afterwards, again + * searches for iterations and then again for sub sequences until no more + * replacements are done. *

*

- * For determining the longest sequence occurring most often, the implementation uses a - * {@link Trie}. The depth of the tree is initially 3. If the algorithm has a longest sequence - * occurring most often whose length is equal to the depth of the trie, it recalculates the trie - * with an increased depth. + * For determining the longest sequence occurring most often, the implementation + * uses a {@link Trie}. The depth of the tree is initially 3. If the algorithm + * has a longest sequence occurring most often whose length is equal to the + * depth of the trie, it recalculates the trie with an increased depth. *

* @@ -62,1078 +64,1157 @@ */ class SequenceForTaskDetectionRule implements ISessionScopeRule { - - /** - *

- * the task factory to be used for creating substructures for the temporal - * relationships identified during rul application - *

- */ - private ITaskFactory taskFactory; - /** - *

- * the task builder to be used for creating substructures for the temporal relationships - * identified during rule application - *

- */ - private ITaskBuilder taskBuilder; - - /** - *

- * the task handling strategy to be used for comparing tasks for preparation, i.e., before - * the tasks are harmonized - *

- */ - private TaskHandlingStrategy preparationTaskHandlingStrategy; - - /** - *

- * the task handling strategy to be used for comparing tasks during iteration detection an trie - * generation, i.e., after the tasks are harmonized - *

- */ - private TaskHandlingStrategy identityTaskHandlingStrategy;; - - /** - *

- * instantiates the rule and initializes it with a task equality to be considered when - * comparing tasks as well as a task factory and builder to be used for creating task - * structures. - *

- * - * @param minimalTaskEquality the task equality to be considered when comparing tasks - * @param taskFactory the task factory to be used for creating substructures - * @param taskBuilder the task builder to be used for creating substructures - */ - SequenceForTaskDetectionRule(TaskEquality minimalTaskEquality, - ITaskFactory taskFactory, - ITaskBuilder taskBuilder) - { - this.taskFactory = taskFactory; - this.taskBuilder = taskBuilder; - - this.preparationTaskHandlingStrategy = new TaskHandlingStrategy(minimalTaskEquality); - this.identityTaskHandlingStrategy = new TaskHandlingStrategy(TaskEquality.IDENTICAL); - } - - /* (non-Javadoc) - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - return "SequenceForTaskDetectionRule"; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.temporalrelation.ISessionScopeRule#apply(java.util.List) - */ - @Override - public RuleApplicationResult apply(List sessions) { - RuleApplicationData appData = new RuleApplicationData(sessions); - - // this is the real rule application. Loop while something is replaced. - harmonizeEventTaskInstancesModel(appData); - do { - System.out.println(); - - appData.getStopWatch().start("whole loop"); - detectAndReplaceIterations(appData); - - appData.getStopWatch().start("task replacement"); - detectAndReplaceTasks(appData); - appData.getStopWatch().stop("task replacement"); - appData.getStopWatch().stop("whole loop"); - - //((TaskTreeNodeComparator) taskComparator).getStopWatch().dumpStatistics(System.out); - //((TaskTreeNodeComparator) taskComparator).getStopWatch().reset(); - - appData.getStopWatch().dumpStatistics(System.out); - appData.getStopWatch().reset(); - - } - while (appData.detectedAndReplacedTasks()); - - Console.println - ("created " + appData.getResult().getNewlyCreatedTasks().size() + - " new tasks and " + appData.getResult().getNewlyCreatedTaskInstances().size() + - " appropriate instances\n"); - - if ((appData.getResult().getNewlyCreatedTasks().size() > 0) || - (appData.getResult().getNewlyCreatedTaskInstances().size() > 0)) - { - appData.getResult().setRuleApplicationStatus(RuleApplicationStatus.FINISHED); - } - - return appData.getResult(); - } - - /** - *

- * harmonizes the event task instances by unifying tasks. This is done, as initially the - * event tasks being equal with respect to the considered task equality are distinct objects. - * The comparison of these distinct objects is more time consuming than comparing the object - * references. - *

- * - * @param appData the rule application data combining all data used for applying this rule - */ - private void harmonizeEventTaskInstancesModel(RuleApplicationData appData) { - Console.traceln(Level.INFO, "harmonizing task model of event task instances"); - appData.getStopWatch().start("harmonizing event tasks"); - - SymbolMap uniqueTasks = - preparationTaskHandlingStrategy.createSymbolMap(); - TaskInstanceComparator comparator = preparationTaskHandlingStrategy.getTaskComparator(); - - int unifiedTasks = 0; - ITask task; - List sessions = appData.getSessions(); - int sessionNo = 0; - for (IUserSession session : sessions) { - Console.traceln(Level.FINE, "handling " + (++sessionNo) + ". " + session); - for (ITaskInstance taskInstance : session) { - task = uniqueTasks.getValue(taskInstance); - - if (task == null) { - uniqueTasks.addSymbol(taskInstance, taskInstance.getTask()); - } - else { - taskBuilder.setTask(taskInstance, task); - unifiedTasks++; - } - } - - comparator.clearBuffers(); - } - - appData.getStopWatch().stop("harmonizing event tasks"); - Console.traceln(Level.INFO, "harmonized " + unifiedTasks + " task occurrences (still " + - uniqueTasks.size() + " different tasks)"); - - appData.getStopWatch().dumpStatistics(System.out); - appData.getStopWatch().reset(); - } - - /** - *

- * searches for direct iterations of single tasks in all sequences and replaces them with - * {@link IIteration}s, respectively appropriate instances. Also all single occurrences of - * a task that is iterated somewhen are replaced with iterations to have again an efficient - * way for task comparisons. - *

- * - * @param appData the rule application data combining all data used for applying this rule - */ - private void detectAndReplaceIterations(RuleApplicationData appData) { - Console.traceln(Level.FINE, "detecting iterations"); - appData.getStopWatch().start("detecting iterations"); - - List sessions = appData.getSessions(); - - Set iteratedTasks = searchIteratedTasks(sessions); - - if (iteratedTasks.size() > 0) { - replaceIterationsOf(iteratedTasks, sessions, appData); - } - - appData.getStopWatch().stop("detecting iterations"); - Console.traceln(Level.INFO, "replaced " + iteratedTasks.size() + " iterated tasks"); - } - - /** - *

- * searches the provided sessions for task iterations. If a task is iterated, it is added - * to the returned set. - *

- * - * @param the session to search for iterations in - * - * @return a set of tasks being iterated somewhere - */ - private Set searchIteratedTasks(List sessions) { - Set iteratedTasks = new HashSet(); - for (IUserSession session : sessions) { - for (int i = 0; i < (session.size() - 1); i++) { - // we prepared the task instances to refer to unique tasks, if they are treated - // as equal. Therefore, we just compare the identity of the tasks of the task - // instances - if (session.get(i).getTask() == session.get(i + 1).getTask()) { - iteratedTasks.add(session.get(i).getTask()); - } - } - } - - return iteratedTasks; - } - - /** - *

- * replaces all occurrences of all tasks provided in the set with iterations - *

- * - * @param iteratedTasks the tasks to be replaced with iterations - * @param sessions the sessions in which the tasks are to be replaced - * @param appData the rule application data combining all data used for applying this rule - */ - private void replaceIterationsOf(Set iteratedTasks, - List sessions, - RuleApplicationData appData) - { - Map iterations = new HashMap(); - Map> iterationInstances = - new HashMap>(); - - for (ITask iteratedTask : iteratedTasks) { - IIteration iteration = taskFactory.createNewIteration(); - iterations.put(iteratedTask, iteration); - iterationInstances.put(iteration, new LinkedList()); - } - - IIterationInstance iterationInstance; - - for (IUserSession session : sessions) { - int index = 0; - iterationInstance = null; - - while (index < session.size()) { - // we prepared the task instances to refer to unique tasks, if they are treated - // as equal. Therefore, we just compare the identity of the tasks of the task - // instances - ITask currentTask = session.get(index).getTask(); - IIteration iteration = iterations.get(currentTask); - if (iteration != null) { - if ((iterationInstance == null) || (iterationInstance.getTask() != iteration)) - { - iterationInstance = taskFactory.createNewTaskInstance(iteration); - iterationInstances.get(iteration).add(iterationInstance); - taskBuilder.addTaskInstance(session, index, iterationInstance); - index++; - } - - taskBuilder.addChild(iterationInstance, session.get(index)); - taskBuilder.removeTaskInstance(session, index); - } - else { - if (iterationInstance != null) { - iterationInstance = null; - } - index++; - } - } - } - - for (Map.Entry> entry : iterationInstances.entrySet()) - { - harmonizeIterationInstancesModel(entry.getKey(), entry.getValue()); - } - } - - /** - *

- * TODO clarify why this is done - *

- */ - private void harmonizeIterationInstancesModel(IIteration iteration, - List iterationInstances) - { - List iteratedTaskVariants = new LinkedList(); - TaskInstanceComparator comparator = preparationTaskHandlingStrategy.getTaskComparator(); - - // merge the lexically different variants of iterated task to a unique list - for (IIterationInstance iterationInstance : iterationInstances) { - for (ITaskInstance executionVariant : iterationInstance) { - ITask candidate = executionVariant.getTask(); - - boolean found = false; - for (ITask taskVariant : iteratedTaskVariants) { - if (comparator.areLexicallyEqual(taskVariant, candidate)) { - taskBuilder.setTask(executionVariant, taskVariant); - found = true; - break; - } - } - - if (!found) { - iteratedTaskVariants.add(candidate); - } - } - } - - // if there are more than one lexically different variant of iterated tasks, adapt the - // iteration model to be a selection of different variants. In this case also adapt - // the generated iteration instances to correctly contain selection instances. If there - // is only one variant of an iterated task, simply set this as the marked task of the - // iteration. In this case, the instances can be preserved as is - if (iteratedTaskVariants.size() > 1) { - ISelection selection = taskFactory.createNewSelection(); - - for (ITask variant : iteratedTaskVariants) { - taskBuilder.addChild(selection, variant); - } - - taskBuilder.setMarkedTask(iteration, selection); - - for (IIterationInstance instance : iterationInstances) { - for (int i = 0; i < instance.size(); i++) { - ISelectionInstance selectionInstance = - taskFactory.createNewTaskInstance(selection); - taskBuilder.setChild(selectionInstance, instance.get(i)); - taskBuilder.setTaskInstance(instance, i, selectionInstance); - } - } - } - else { - taskBuilder.setMarkedTask(iteration, iteratedTaskVariants.get(0)); - } - } - - /** - * TODO go on commenting - * @param appData the rule application data combining all data used for applying this rule - */ - private void detectAndReplaceTasks(RuleApplicationData appData) { - Console.traceln(Level.FINE, "detecting and replacing tasks"); - appData.getStopWatch().start("detecting tasks"); - - getSequencesOccuringMostOften(appData); - - appData.getStopWatch().stop("detecting tasks"); - appData.getStopWatch().start("replacing tasks"); - - replaceSequencesOccurringMostOften(appData); - - appData.getStopWatch().stop("replacing tasks"); - Console.traceln(Level.INFO, "detected and replaced " + appData.getLastFoundTasks().size() + - " tasks occuring " + appData.getLastFoundTasks().getOccurrenceCount() + - " times"); - } - - /** - * @param appData the rule application data combining all data used for applying this rule - */ - private void getSequencesOccuringMostOften(RuleApplicationData appData) { - Console.traceln(Level.FINE, "determining most prominent tasks"); - - Tasks tasks; - boolean createNewTrie = (appData.getLastTrie() == null) || - appData.detectedAndReplacedTasks(); // tree has changed - - do { - if (createNewTrie) { - createNewTrie(appData); - } - - MaxCountAndLongestTasksFinder finder = new MaxCountAndLongestTasksFinder(); - appData.getLastTrie().process(finder); - - tasks = finder.getFoundTasks(); - - createNewTrie = false; - - for (List task : tasks) { - if (task.size() >= appData.getTrainedSequenceLength()) { - // Trie must be recreated with a longer sequence length to be sure that - // the found sequences occurring most often are found in their whole length - appData.setTrainedSequenceLength(appData.getTrainedSequenceLength() + 1); - createNewTrie = true; - break; - } - } - } - while (createNewTrie); - - // create a normal trie for comparison - /*System.out.println("creating test trie for comparison"); - - appData.getStopWatch().start("testtrie"); - Trie trie = new Trie(identityTaskComparator); - - for (IUserSession session : appData.getSessions()) { - trie.train(session.getExecutedTasks(), appData.getTrainedSequenceLength()); - } - - appData.getStopWatch().stop("testtrie"); - - MaxCountAndLongestTasksFinder finder = new MaxCountAndLongestTasksFinder(); - trie.process(finder); - - boolean allTasksEqual = finder.getFoundTasks().size() == tasks.size(); - - allTasksEqual &= finder.getFoundTasks().occurrenceCount == tasks.occurrenceCount; - - for (List task1 : finder.getFoundTasks()) { - boolean foundTask = false; - for (List task2 : tasks) { - boolean tasksEqual = false; - if (task1.size() == task2.size()) { - tasksEqual = true; - for (int i = 0; i < task1.size(); i++) { - if (!identityTaskComparator.equals(task1.get(i).getTask(), task2.get(i).getTask())) - { - tasksEqual = false; - } - } - } - - if (tasksEqual) { - foundTask = true; - break; - } - } - - if (!foundTask) { - System.out.println("different is " + task1); - allTasksEqual = false; - break; - } - } - - if (!allTasksEqual) { - System.out.println(finder.getFoundTasks()); - System.out.println(tasks); - - throw new IllegalArgumentException("both tries calculated different subsequences"); - } - - /*TrieStatisticsDumper dumper = new TrieStatisticsDumper(); - appData.getLastTrie().process(dumper); - dumper.dumpCounters();*/ - - appData.setLastFoundTasks(tasks); - - Console.traceln(Level.FINE, "found " + appData.getLastFoundTasks().size() + " tasks " + - "occurring " + appData.getLastFoundTasks().getOccurrenceCount() + " times"); - } - - /** - * @param appData the rule application data combining all data used for applying this rule - */ - private void createNewTrie(RuleApplicationData appData) { - Console.traceln(Level.FINER, "training trie with a maximum sequence length of " + - appData.getTrainedSequenceLength()); - - appData.getStopWatch().start("training trie"); - - // we prepared the task instances to refer to unique tasks, if they are treated - // as equal. Therefore, we just compare the identity of the tasks of the task - // instances - appData.setLastTrie(new TaskInstanceTrie(identityTaskHandlingStrategy)); - - appData.getLastTrie().trainSessions - (appData.getSessions(), appData.getTrainedSequenceLength()); - - appData.getStopWatch().stop("training trie"); - } - - /** - * @param appData the rule application data combining all data used for applying this rule - */ - private void replaceSequencesOccurringMostOften(RuleApplicationData appData) { - appData.detectedAndReplacedTasks(false); - - if ((appData.getLastFoundTasks().size() > 0) && - (appData.getLastFoundTasks().getOccurrenceCount() > 1)) - { - Console.traceln(Level.FINER, "replacing tasks occurrences"); - - for (List task : appData.getLastFoundTasks()) { - ISequence sequence = taskFactory.createNewSequence(); - - Console.traceln(Level.FINEST, "replacing " + sequence.getId() + ": " + task); - - List sequenceInstances = - replaceTaskOccurrences(task, appData.getSessions(), sequence); - - harmonizeSequenceInstancesModel(sequence, sequenceInstances,task.size()); - appData.detectedAndReplacedTasks - (appData.detectedAndReplacedTasks() || (sequenceInstances.size() > 0)); - - if (sequenceInstances.size() < appData.getLastFoundTasks().getOccurrenceCount()) { - Console.traceln(Level.FINE, sequence.getId() + ": replaced task only " + - sequenceInstances.size() + " times instead of expected " + - appData.getLastFoundTasks().getOccurrenceCount()); - } - } - } - - } - - /** - * - */ - private void harmonizeSequenceInstancesModel(ISequence sequence, - List sequenceInstances, - int sequenceLength) - { - TaskInstanceComparator comparator = preparationTaskHandlingStrategy.getTaskComparator(); - - // ensure for each subtask that lexically different variants are preserved - for (int subTaskIndex = 0; subTaskIndex < sequenceLength; subTaskIndex++) { - List subTaskVariants = new LinkedList(); - - for (ISequenceInstance sequenceInstance : sequenceInstances) { - ITask candidate = sequenceInstance.get(subTaskIndex).getTask(); - - boolean found = false; - - for (int i = 0; i < subTaskVariants.size(); i++) { - if (comparator.areLexicallyEqual(subTaskVariants.get(i), candidate)) { - taskBuilder.setTask - (sequenceInstance.get(subTaskIndex), subTaskVariants.get(i)); - - found = true; - break; - } - } - - if (!found) { - subTaskVariants.add(candidate); - } - } - - // if there are more than one lexically different variant of the sub task at - // the considered position, adapt the sequence model at that position to have - // a selection of the different variants. In this case also adapt the - // generated sequence instances to correctly contain selection instances. If - // there is only one variant of sub tasks at the given position, simply set - // this variant as the sub task of the selection. In this case, the instances - // can be preserved as is - if (subTaskVariants.size() > 1) { - ISelection selection = taskFactory.createNewSelection(); - - for (ITask variant : subTaskVariants) { - taskBuilder.addChild(selection, variant); - } - - taskBuilder.addChild(sequence, selection); - - for (ISequenceInstance instance : sequenceInstances) { - ISelectionInstance selectionInstance = - taskFactory.createNewTaskInstance(selection); - taskBuilder.setChild(selectionInstance, instance.get(subTaskIndex)); - taskBuilder.setTaskInstance(instance, subTaskIndex, selectionInstance); - } - } - else if (subTaskVariants.size() == 1) { - taskBuilder.addChild(sequence, subTaskVariants.get(0)); - } - } - } - - /** - * @param tree - */ - private List replaceTaskOccurrences(List task, - List sessions, - ISequence temporalTaskModel) - { - List sequenceInstances = new LinkedList(); - - for (IUserSession session : sessions) { - int index = -1; - - do { - index = getSubListIndex(session, task, ++index); - - if (index > -1) { - sequenceInstances.add - (RuleUtils.createNewSubSequenceInRange - (session, index, index + task.size() - 1, temporalTaskModel, - taskFactory, taskBuilder)); - } - } - while (index > -1); - } - - return sequenceInstances; - } - - /** - * @param trie - * @param object - * @return - */ - private int getSubListIndex(ITaskInstanceList list, - List subList, - int startIndex) - { - boolean matchFound; - int result = -1; - - for (int i = startIndex; i <= list.size() - subList.size(); i++) { - matchFound = true; - - for (int j = 0; j < subList.size(); j++) { - // we prepared the task instances to refer to unique tasks, if they are treated - // as equal. Therefore, we just compare the identity of the tasks of the task - // instances - if (list.get(i + j).getTask() != subList.get(j).getTask()) { - matchFound = false; - break; - } - } - - if (matchFound) { - result = i; - break; - } - } - - return result; - } - - /** - * @param trie - * @param object - * @return - */ - private int getSubListIndex(List list, - List subList, - int startIndex) - { - boolean matchFound; - int result = -1; - - for (int i = startIndex; i <= list.size() - subList.size(); i++) { - matchFound = true; - - for (int j = 0; j < subList.size(); j++) { - // we prepared the task instances to refer to unique tasks, if they are treated - // as equal. Therefore, we just compare the identity of the tasks of the task - // instances - if (list.get(i + j) != subList.get(j)) { - matchFound = false; - break; - } - } - - if (matchFound) { - result = i; - break; - } - } - - return result; - } - - /** - * @author Patrick Harms - */ - private class MaxCountAndLongestTasksFinder implements TrieProcessor { - - /** - * - */ - private int currentCount; - - /** - * - */ - private List> foundTasks = new LinkedList>(); - - /** - * - */ - public MaxCountAndLongestTasksFinder() { - super(); - this.currentCount = 0; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.TrieProcessor#process(java.util.List, int) - */ - @Override - public TrieProcessor.Result process(List foundTask, int count) { - if (foundTask.size() < 2) { - // ignore single tasks - return TrieProcessor.Result.CONTINUE; - } - - if (count < 2) { - // ignore singular occurrences - return TrieProcessor.Result.SKIP_NODE; - } - - if (this.currentCount > count) { - // ignore this children of this task, as they may have only smaller counts than - // the already found tasks - return TrieProcessor.Result.SKIP_NODE; - } - - if (this.currentCount < count) { - // the provided task occurs more often that all tasks found so far. - // clear all found tasks and use the new count as the one searched for - foundTasks.clear(); - this.currentCount = count; - } - - if (this.currentCount == count) { - // the task is of interest. Sort it into the other found tasks so that - // the longest come first - boolean added = false; - for (int i = 0; i < foundTasks.size(); i++) { - if (foundTasks.get(i).size() < foundTask.size()) { - // defensive copy - foundTasks.add(i, new LinkedList(foundTask)); // defensive copy - added = true; - break; - } - } - - if (!added) { - foundTasks.add(new LinkedList(foundTask)); // defensive copy - } - } - - return TrieProcessor.Result.CONTINUE; - } - - /** - * @return - */ - public Tasks getFoundTasks() { - removePermutationsOfShorterTasks(); - return new Tasks(currentCount, foundTasks); - } - - /** - * - */ - private void removePermutationsOfShorterTasks() { - // now iterate the sorted list and for each task remove all other tasks that are shorter - // (i.e. come later in the sorted list) and that represent a subpart of the task - for (int i = 0; i < foundTasks.size(); i++) { - for (int j = i + 1; j < foundTasks.size();) { - if (foundTasks.get(j).size() < foundTasks.get(i).size()) { - // found a task that is a potential subtask. Check for this and remove the - // subtask if needed - List longTask = foundTasks.get(i); - List shortTask = foundTasks.get(j); - - if (getSubListIndex(longTask, shortTask, 0) > -1) { - foundTasks.remove(j); - } - else { - j++; - } - } - else { - j++; - } - } - } - } - - } - -// /** -// * @author Patrick Harms -// */ -// private class TrieStatisticsDumper implements TrieProcessor { -// -// /** -// * -// */ -// private Map counters = new HashMap(); -// -// /* (non-Javadoc) -// * @see de.ugoe.cs.autoquest.usageprofiles.TrieProcessor#process(java.util.List, int) -// */ -// @Override -// public TrieProcessor.Result process(List subsequence, int count) { -// if (subsequence.size() == 1) { -// Integer value = counters.get(count); -// -// if (value == null) { -// value = 0; -// } -// -// counters.put(count, value + 1); -// -// return TrieProcessor.Result.CONTINUE; -// } -// else { -// // ignore singular occurrences -// return TrieProcessor.Result.SKIP_NODE; -// } -// } -// -// /** -// * @return -// */ -// public void dumpCounters() { -// int dumpedCounters = 0; -// -// int count = 1; -// while (dumpedCounters < counters.size()) { -// Integer value = counters.get(count++); -// if (value != null) { -// System.out.println(value + " symbols occurred " + count + " times"); -// dumpedCounters++; -// } -// } -// } -// -// } - - /** - * - */ - private static class RuleApplicationData { - - /** - * - */ - private List sessions; - - /** - * - */ - private TaskInstanceTrie lastTrie; - - /** - * default and minimum trained sequence length is 3 - */ - private int trainedSequenceLength = 3; - - /** - * - */ - private Tasks lastFoundTasks = new Tasks(Integer.MAX_VALUE, null); - - /** - * - */ - private boolean detectedAndReplacedTasks; - - /** - * - */ - private RuleApplicationResult result = new RuleApplicationResult(); - - /** - * - */ - private StopWatch stopWatch = new StopWatch(); - - /** - * - */ - private RuleApplicationData(List sessions) { - this.sessions = sessions; - } - - /** - * @return the tree - */ - private List getSessions() { - return sessions; - } - - /** - * @param lastTrie the lastTrie to set - */ - private void setLastTrie(TaskInstanceTrie lastTrie) { - this.lastTrie = lastTrie; - } - - /** - * @return the lastTrie - */ - private TaskInstanceTrie getLastTrie() { - return lastTrie; - } - - /** - * @param trainedSequenceLength the trainedSequenceLength to set - */ - private void setTrainedSequenceLength(int trainedSequenceLength) { - this.trainedSequenceLength = trainedSequenceLength; - } - - /** - * @return the trainedSequenceLength - */ - private int getTrainedSequenceLength() { - return trainedSequenceLength; - } - - /** - * @param lastFoundSequences the lastFoundSequences to set - */ - private void setLastFoundTasks(Tasks lastFoundSequences) { - this.lastFoundTasks = lastFoundSequences; - } - - /** - * @return the lastFoundSequences - */ - private Tasks getLastFoundTasks() { - return lastFoundTasks; - } - - /** - * - */ - private void detectedAndReplacedTasks(boolean detectedAndReplacedTasks) { - this.detectedAndReplacedTasks = detectedAndReplacedTasks; - } - - /** - * - */ - private boolean detectedAndReplacedTasks() { - return detectedAndReplacedTasks; - } - - /** - * @return the result - */ - private RuleApplicationResult getResult() { - return result; - } - - /** - * @return the stopWatch - */ - private StopWatch getStopWatch() { - return stopWatch; - } - - } - - - /** - * @author Patrick Harms - */ - private static class Tasks implements Iterable> { - - /** - * - */ - private int occurrenceCount; - - /** - * - */ - private List> sequences; - - /** - * @param occurrenceCount - * @param sequences - */ - private Tasks(int occurrenceCount, List> sequences) { - super(); - this.occurrenceCount = occurrenceCount; - this.sequences = sequences; - } - - /** - * @return - */ - private int getOccurrenceCount() { - return occurrenceCount; - } - - /** - * @return - */ - private int size() { - return this.sequences.size(); - } - - /** - * - */ - - /* (non-Javadoc) - * @see java.lang.Iterable#iterator() - */ - @Override - public Iterator> iterator() { - return this.sequences.iterator(); - } - - /* (non-Javadoc) - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - StringBuffer result = new StringBuffer(); - result.append(this.occurrenceCount); - result.append(" occurrences:\n"); - - for (List task : sequences) { - result.append(task); - result.append("\n"); - } - - return result.toString(); - } - - } - - // methods for internal testing -// private void checkMatchingOfSessions(List> flattenedSessions, -// List sessions, -// String when) -// { -// List> currentFlattenedSessions = flattenSessions(sessions); -// if (flattenedSessions.size() != currentFlattenedSessions.size()) { -// System.out.println("################## number of sessions changed after " + when); -// } -// else { -// for (int i = 0; i < flattenedSessions.size(); i++) { -// List expected = flattenedSessions.get(i); -// List current = currentFlattenedSessions.get(i); -// -// if (expected.size() != current.size()) { -// System.out.println -// ("################## length of session " + i + " changed after " + when); -// } -// else { -// for (int j = 0; j < expected.size(); j++) { -// if (!expected.get(j).equals(current.get(j))) { -// System.out.println("################## event " + j + " of session " + -// i + " changed after " + when); -// } -// } -// } -// } -// } -// } -// -// private List> flattenSessions(List sessions) { -// List> flattenedSessions = new ArrayList>(); -// for (IUserSession session : sessions) { -// List flattenedUserSession = new ArrayList(); -// flatten(session, flattenedUserSession); -// flattenedSessions.add(flattenedUserSession); -// } -// -// return flattenedSessions; -// } -// -// private void flatten(IUserSession iUserSession, List flattenedUserSession) { -// for (ITaskInstance instance : iUserSession) { -// flatten(instance, flattenedUserSession); -// } -// } -// -// private void flatten(ITaskInstance instance, List flattenedUserSession) { -// if (instance instanceof ITaskInstanceList) { -// for (ITaskInstance child : (ITaskInstanceList) instance) { -// flatten(child, flattenedUserSession); -// } -// } -// else if (instance instanceof ISelectionInstance) { -// flatten(((ISelectionInstance) instance).getChild(), flattenedUserSession); -// } -// else if (instance instanceof IOptionalInstance) { -// flatten(((IOptionalInstance) instance).getChild(), flattenedUserSession); -// } -// else if (instance instanceof IEventTaskInstance) { -// flattenedUserSession.add(((IEventTaskInstance) instance).getEvent()); -// } -// } + + /** + * @author Patrick Harms + */ + private class MaxCountAndLongestTasksFinder implements + TrieProcessor { + + /** + * + */ + private int currentCount; + + /** + * + */ + private final List> foundTasks = new LinkedList>(); + + /** + * + */ + public MaxCountAndLongestTasksFinder() { + super(); + this.currentCount = 0; + } + + /** + * @return + */ + public Tasks getFoundTasks() { + removePermutationsOfShorterTasks(); + return new Tasks(currentCount, foundTasks); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.usageprofiles.TrieProcessor#process(java.util + * .List, int) + */ + @Override + public TrieProcessor.Result process(List foundTask, + int count) { + if (foundTask.size() < 2) { + // ignore single tasks + return TrieProcessor.Result.CONTINUE; + } + + if (count < 2) { + // ignore singular occurrences + return TrieProcessor.Result.SKIP_NODE; + } + + if (this.currentCount > count) { + // ignore this children of this task, as they may have only + // smaller counts than + // the already found tasks + return TrieProcessor.Result.SKIP_NODE; + } + + if (this.currentCount < count) { + // the provided task occurs more often that all tasks found so + // far. + // clear all found tasks and use the new count as the one + // searched for + foundTasks.clear(); + this.currentCount = count; + } + + if (this.currentCount == count) { + // the task is of interest. Sort it into the other found tasks + // so that + // the longest come first + boolean added = false; + for (int i = 0; i < foundTasks.size(); i++) { + if (foundTasks.get(i).size() < foundTask.size()) { + // defensive copy + foundTasks.add(i, new LinkedList( + foundTask)); // defensive copy + added = true; + break; + } + } + + if (!added) { + foundTasks.add(new LinkedList(foundTask)); // defensive + // copy + } + } + + return TrieProcessor.Result.CONTINUE; + } + + /** + * + */ + private void removePermutationsOfShorterTasks() { + // now iterate the sorted list and for each task remove all other + // tasks that are shorter + // (i.e. come later in the sorted list) and that represent a subpart + // of the task + for (int i = 0; i < foundTasks.size(); i++) { + for (int j = i + 1; j < foundTasks.size();) { + if (foundTasks.get(j).size() < foundTasks.get(i).size()) { + // found a task that is a potential subtask. Check for + // this and remove the + // subtask if needed + final List longTask = foundTasks.get(i); + final List shortTask = foundTasks.get(j); + + if (getSubListIndex(longTask, shortTask, 0) > -1) { + foundTasks.remove(j); + } else { + j++; + } + } else { + j++; + } + } + } + } + + } + + /** + * + */ + private static class RuleApplicationData { + + /** + * + */ + private final List sessions; + + /** + * + */ + private TaskInstanceTrie lastTrie; + + /** + * default and minimum trained sequence length is 3 + */ + private int trainedSequenceLength = 3; + + /** + * + */ + private Tasks lastFoundTasks = new Tasks(Integer.MAX_VALUE, null); + + /** + * + */ + private boolean detectedAndReplacedTasks; + + /** + * + */ + private final RuleApplicationResult result = new RuleApplicationResult(); + + /** + * + */ + private final StopWatch stopWatch = new StopWatch(); + + /** + * + */ + private RuleApplicationData(List sessions) { + this.sessions = sessions; + } + + /** + * + */ + private boolean detectedAndReplacedTasks() { + return detectedAndReplacedTasks; + } + + /** + * + */ + private void detectedAndReplacedTasks(boolean detectedAndReplacedTasks) { + this.detectedAndReplacedTasks = detectedAndReplacedTasks; + } + + /** + * @return the lastFoundSequences + */ + private Tasks getLastFoundTasks() { + return lastFoundTasks; + } + + /** + * @return the lastTrie + */ + private TaskInstanceTrie getLastTrie() { + return lastTrie; + } + + /** + * @return the result + */ + private RuleApplicationResult getResult() { + return result; + } + + /** + * @return the tree + */ + private List getSessions() { + return sessions; + } + + /** + * @return the stopWatch + */ + private StopWatch getStopWatch() { + return stopWatch; + } + + /** + * @return the trainedSequenceLength + */ + private int getTrainedSequenceLength() { + return trainedSequenceLength; + } + + /** + * @param lastFoundSequences + * the lastFoundSequences to set + */ + private void setLastFoundTasks(Tasks lastFoundSequences) { + this.lastFoundTasks = lastFoundSequences; + } + + /** + * @param lastTrie + * the lastTrie to set + */ + private void setLastTrie(TaskInstanceTrie lastTrie) { + this.lastTrie = lastTrie; + } + + /** + * @param trainedSequenceLength + * the trainedSequenceLength to set + */ + private void setTrainedSequenceLength(int trainedSequenceLength) { + this.trainedSequenceLength = trainedSequenceLength; + } + + } + + /** + * @author Patrick Harms + */ + private static class Tasks implements Iterable> { + + /** + * + */ + private final int occurrenceCount; + + /** + * + */ + private final List> sequences; + + /** + * @param occurrenceCount + * @param sequences + */ + private Tasks(int occurrenceCount, List> sequences) { + super(); + this.occurrenceCount = occurrenceCount; + this.sequences = sequences; + } + + /** + * @return + */ + private int getOccurrenceCount() { + return occurrenceCount; + } + + /** + * + */ + + /* + * (non-Javadoc) + * + * @see java.lang.Iterable#iterator() + */ + @Override + public Iterator> iterator() { + return this.sequences.iterator(); + } + + /** + * @return + */ + private int size() { + return this.sequences.size(); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + final StringBuffer result = new StringBuffer(); + result.append(this.occurrenceCount); + result.append(" occurrences:\n"); + + for (final List task : sequences) { + result.append(task); + result.append("\n"); + } + + return result.toString(); + } + + } + + /** + *

+ * the task factory to be used for creating substructures for the temporal + * relationships identified during rul application + *

+ */ + private final ITaskFactory taskFactory;; + + /** + *

+ * the task builder to be used for creating substructures for the temporal + * relationships identified during rule application + *

+ */ + private final ITaskBuilder taskBuilder; + + /** + *

+ * the task handling strategy to be used for comparing tasks for + * preparation, i.e., before the tasks are harmonized + *

+ */ + private final TaskHandlingStrategy preparationTaskHandlingStrategy; + + /** + *

+ * the task handling strategy to be used for comparing tasks during + * iteration detection an trie generation, i.e., after the tasks are + * harmonized + *

+ */ + private final TaskHandlingStrategy identityTaskHandlingStrategy; + + /** + *

+ * instantiates the rule and initializes it with a task equality to be + * considered when comparing tasks as well as a task factory and builder to + * be used for creating task structures. + *

+ * + * @param minimalTaskEquality + * the task equality to be considered when comparing tasks + * @param taskFactory + * the task factory to be used for creating substructures + * @param taskBuilder + * the task builder to be used for creating substructures + */ + SequenceForTaskDetectionRule(TaskEquality minimalTaskEquality, + ITaskFactory taskFactory, ITaskBuilder taskBuilder) { + this.taskFactory = taskFactory; + this.taskBuilder = taskBuilder; + + this.preparationTaskHandlingStrategy = new TaskHandlingStrategy( + minimalTaskEquality); + this.identityTaskHandlingStrategy = new TaskHandlingStrategy( + TaskEquality.IDENTICAL); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.temporalrelation.ISessionScopeRule#apply + * (java.util.List) + */ + @Override + public RuleApplicationResult apply(List sessions) { + final RuleApplicationData appData = new RuleApplicationData(sessions); + + // this is the real rule application. Loop while something is replaced. + harmonizeEventTaskInstancesModel(appData); + do { + System.out.println(); + + appData.getStopWatch().start("whole loop"); + detectAndReplaceIterations(appData); + + appData.getStopWatch().start("task replacement"); + detectAndReplaceTasks(appData); + appData.getStopWatch().stop("task replacement"); + appData.getStopWatch().stop("whole loop"); + + // ((TaskTreeNodeComparator) + // taskComparator).getStopWatch().dumpStatistics(System.out); + // ((TaskTreeNodeComparator) taskComparator).getStopWatch().reset(); + + appData.getStopWatch().dumpStatistics(System.out); + appData.getStopWatch().reset(); + + } while (appData.detectedAndReplacedTasks()); + + Console.println("created " + + appData.getResult().getNewlyCreatedTasks().size() + + " new tasks and " + + appData.getResult().getNewlyCreatedTaskInstances().size() + + " appropriate instances\n"); + + if ((appData.getResult().getNewlyCreatedTasks().size() > 0) + || (appData.getResult().getNewlyCreatedTaskInstances().size() > 0)) { + appData.getResult().setRuleApplicationStatus( + RuleApplicationStatus.FINISHED); + } + + return appData.getResult(); + } + + /** + * @param appData + * the rule application data combining all data used for applying + * this rule + */ + private void createNewTrie(RuleApplicationData appData) { + Console.traceln( + Level.FINER, + "training trie with a maximum sequence length of " + + appData.getTrainedSequenceLength()); + + appData.getStopWatch().start("training trie"); + + // we prepared the task instances to refer to unique tasks, if they are + // treated + // as equal. Therefore, we just compare the identity of the tasks of the + // task + // instances + appData.setLastTrie(new TaskInstanceTrie(identityTaskHandlingStrategy)); + + appData.getLastTrie().trainSessions(appData.getSessions(), + appData.getTrainedSequenceLength()); + + appData.getStopWatch().stop("training trie"); + } + + /** + *

+ * searches for direct iterations of single tasks in all sequences and + * replaces them with {@link IIteration}s, respectively appropriate + * instances. Also all single occurrences of a task that is iterated + * somewhen are replaced with iterations to have again an efficient way for + * task comparisons. + *

+ * + * @param appData + * the rule application data combining all data used for applying + * this rule + */ + private void detectAndReplaceIterations(RuleApplicationData appData) { + Console.traceln(Level.FINE, "detecting iterations"); + appData.getStopWatch().start("detecting iterations"); + + final List sessions = appData.getSessions(); + + final Set iteratedTasks = searchIteratedTasks(sessions); + + if (iteratedTasks.size() > 0) { + replaceIterationsOf(iteratedTasks, sessions, appData); + } + + appData.getStopWatch().stop("detecting iterations"); + Console.traceln(Level.INFO, "replaced " + iteratedTasks.size() + + " iterated tasks"); + } + + /** + * TODO go on commenting + * + * @param appData + * the rule application data combining all data used for applying + * this rule + */ + private void detectAndReplaceTasks(RuleApplicationData appData) { + Console.traceln(Level.FINE, "detecting and replacing tasks"); + appData.getStopWatch().start("detecting tasks"); + + getSequencesOccuringMostOften(appData); + + appData.getStopWatch().stop("detecting tasks"); + appData.getStopWatch().start("replacing tasks"); + + replaceSequencesOccurringMostOften(appData); + + appData.getStopWatch().stop("replacing tasks"); + Console.traceln(Level.INFO, "detected and replaced " + + appData.getLastFoundTasks().size() + " tasks occuring " + + appData.getLastFoundTasks().getOccurrenceCount() + " times"); + } + + /** + * @param appData + * the rule application data combining all data used for applying + * this rule + */ + private void getSequencesOccuringMostOften(RuleApplicationData appData) { + Console.traceln(Level.FINE, "determining most prominent tasks"); + + Tasks tasks; + boolean createNewTrie = (appData.getLastTrie() == null) + || appData.detectedAndReplacedTasks(); // tree has changed + + do { + if (createNewTrie) { + createNewTrie(appData); + } + + final MaxCountAndLongestTasksFinder finder = new MaxCountAndLongestTasksFinder(); + appData.getLastTrie().process(finder); + + tasks = finder.getFoundTasks(); + + createNewTrie = false; + + for (final List task : tasks) { + if (task.size() >= appData.getTrainedSequenceLength()) { + // Trie must be recreated with a longer sequence length to + // be sure that + // the found sequences occurring most often are found in + // their whole length + appData.setTrainedSequenceLength(appData + .getTrainedSequenceLength() + 1); + createNewTrie = true; + break; + } + } + } while (createNewTrie); + + // create a normal trie for comparison + /* + * System.out.println("creating test trie for comparison"); + * + * appData.getStopWatch().start("testtrie"); Trie trie = + * new Trie(identityTaskComparator); + * + * for (IUserSession session : appData.getSessions()) { + * trie.train(session.getExecutedTasks(), + * appData.getTrainedSequenceLength()); } + * + * appData.getStopWatch().stop("testtrie"); + * + * MaxCountAndLongestTasksFinder finder = new + * MaxCountAndLongestTasksFinder(); trie.process(finder); + * + * boolean allTasksEqual = finder.getFoundTasks().size() == + * tasks.size(); + * + * allTasksEqual &= finder.getFoundTasks().occurrenceCount == + * tasks.occurrenceCount; + * + * for (List task1 : finder.getFoundTasks()) { boolean + * foundTask = false; for (List task2 : tasks) { boolean + * tasksEqual = false; if (task1.size() == task2.size()) { tasksEqual = + * true; for (int i = 0; i < task1.size(); i++) { if + * (!identityTaskComparator.equals(task1.get(i).getTask(), + * task2.get(i).getTask())) { tasksEqual = false; } } } + * + * if (tasksEqual) { foundTask = true; break; } } + * + * if (!foundTask) { System.out.println("different is " + task1); + * allTasksEqual = false; break; } } + * + * if (!allTasksEqual) { System.out.println(finder.getFoundTasks()); + * System.out.println(tasks); + * + * throw new + * IllegalArgumentException("both tries calculated different subsequences" + * ); } + * + * /*TrieStatisticsDumper dumper = new TrieStatisticsDumper(); + * appData.getLastTrie().process(dumper); dumper.dumpCounters(); + */ + + appData.setLastFoundTasks(tasks); + + Console.traceln(Level.FINE, "found " + + appData.getLastFoundTasks().size() + " tasks " + "occurring " + + appData.getLastFoundTasks().getOccurrenceCount() + " times"); + } + + /** + * @param trie + * @param object + * @return + */ + private int getSubListIndex(ITaskInstanceList list, + List subList, int startIndex) { + boolean matchFound; + int result = -1; + + for (int i = startIndex; i <= (list.size() - subList.size()); i++) { + matchFound = true; + + for (int j = 0; j < subList.size(); j++) { + // we prepared the task instances to refer to unique tasks, if + // they are treated + // as equal. Therefore, we just compare the identity of the + // tasks of the task + // instances + if (list.get(i + j).getTask() != subList.get(j).getTask()) { + matchFound = false; + break; + } + } + + if (matchFound) { + result = i; + break; + } + } + + return result; + } + + /** + * @param trie + * @param object + * @return + */ + private int getSubListIndex(List list, + List subList, int startIndex) { + boolean matchFound; + int result = -1; + + for (int i = startIndex; i <= (list.size() - subList.size()); i++) { + matchFound = true; + + for (int j = 0; j < subList.size(); j++) { + // we prepared the task instances to refer to unique tasks, if + // they are treated + // as equal. Therefore, we just compare the identity of the + // tasks of the task + // instances + if (list.get(i + j) != subList.get(j)) { + matchFound = false; + break; + } + } + + if (matchFound) { + result = i; + break; + } + } + + return result; + } + + /** + *

+ * harmonizes the event task instances by unifying tasks. This is done, as + * initially the event tasks being equal with respect to the considered task + * equality are distinct objects. The comparison of these distinct objects + * is more time consuming than comparing the object references. + *

+ * + * @param appData + * the rule application data combining all data used for applying + * this rule + */ + private void harmonizeEventTaskInstancesModel(RuleApplicationData appData) { + Console.traceln(Level.INFO, + "harmonizing task model of event task instances"); + appData.getStopWatch().start("harmonizing event tasks"); + + final SymbolMap uniqueTasks = preparationTaskHandlingStrategy + .createSymbolMap(); + final TaskInstanceComparator comparator = preparationTaskHandlingStrategy + .getTaskComparator(); + + int unifiedTasks = 0; + ITask task; + final List sessions = appData.getSessions(); + int sessionNo = 0; + for (final IUserSession session : sessions) { + Console.traceln(Level.FINE, "handling " + (++sessionNo) + ". " + + session); + for (final ITaskInstance taskInstance : session) { + task = uniqueTasks.getValue(taskInstance); + + if (task == null) { + uniqueTasks.addSymbol(taskInstance, taskInstance.getTask()); + } else { + taskBuilder.setTask(taskInstance, task); + unifiedTasks++; + } + } + + comparator.clearBuffers(); + } + + appData.getStopWatch().stop("harmonizing event tasks"); + Console.traceln(Level.INFO, "harmonized " + unifiedTasks + + " task occurrences (still " + uniqueTasks.size() + + " different tasks)"); + + appData.getStopWatch().dumpStatistics(System.out); + appData.getStopWatch().reset(); + } + + /** + *

+ * TODO clarify why this is done + *

+ */ + private void harmonizeIterationInstancesModel(IIteration iteration, + List iterationInstances) { + final List iteratedTaskVariants = new LinkedList(); + final TaskInstanceComparator comparator = preparationTaskHandlingStrategy + .getTaskComparator(); + + // merge the lexically different variants of iterated task to a unique + // list + for (final IIterationInstance iterationInstance : iterationInstances) { + for (final ITaskInstance executionVariant : iterationInstance) { + final ITask candidate = executionVariant.getTask(); + + boolean found = false; + for (final ITask taskVariant : iteratedTaskVariants) { + if (comparator.areLexicallyEqual(taskVariant, candidate)) { + taskBuilder.setTask(executionVariant, taskVariant); + found = true; + break; + } + } + + if (!found) { + iteratedTaskVariants.add(candidate); + } + } + } + + // if there are more than one lexically different variant of iterated + // tasks, adapt the + // iteration model to be a selection of different variants. In this case + // also adapt + // the generated iteration instances to correctly contain selection + // instances. If there + // is only one variant of an iterated task, simply set this as the + // marked task of the + // iteration. In this case, the instances can be preserved as is + if (iteratedTaskVariants.size() > 1) { + final ISelection selection = taskFactory.createNewSelection(); + + for (final ITask variant : iteratedTaskVariants) { + taskBuilder.addChild(selection, variant); + } + + taskBuilder.setMarkedTask(iteration, selection); + + for (final IIterationInstance instance : iterationInstances) { + for (int i = 0; i < instance.size(); i++) { + final ISelectionInstance selectionInstance = taskFactory + .createNewTaskInstance(selection); + taskBuilder.setChild(selectionInstance, instance.get(i)); + taskBuilder.setTaskInstance(instance, i, selectionInstance); + } + } + } else { + taskBuilder.setMarkedTask(iteration, iteratedTaskVariants.get(0)); + } + } + + /** + * + */ + private void harmonizeSequenceInstancesModel(ISequence sequence, + List sequenceInstances, int sequenceLength) { + final TaskInstanceComparator comparator = preparationTaskHandlingStrategy + .getTaskComparator(); + + // ensure for each subtask that lexically different variants are + // preserved + for (int subTaskIndex = 0; subTaskIndex < sequenceLength; subTaskIndex++) { + final List subTaskVariants = new LinkedList(); + + for (final ISequenceInstance sequenceInstance : sequenceInstances) { + final ITask candidate = sequenceInstance.get(subTaskIndex) + .getTask(); + + boolean found = false; + + for (int i = 0; i < subTaskVariants.size(); i++) { + if (comparator.areLexicallyEqual(subTaskVariants.get(i), + candidate)) { + taskBuilder.setTask(sequenceInstance.get(subTaskIndex), + subTaskVariants.get(i)); + + found = true; + break; + } + } + + if (!found) { + subTaskVariants.add(candidate); + } + } + + // if there are more than one lexically different variant of the sub + // task at + // the considered position, adapt the sequence model at that + // position to have + // a selection of the different variants. In this case also adapt + // the + // generated sequence instances to correctly contain selection + // instances. If + // there is only one variant of sub tasks at the given position, + // simply set + // this variant as the sub task of the selection. In this case, the + // instances + // can be preserved as is + if (subTaskVariants.size() > 1) { + final ISelection selection = taskFactory.createNewSelection(); + + for (final ITask variant : subTaskVariants) { + taskBuilder.addChild(selection, variant); + } + + taskBuilder.addChild(sequence, selection); + + for (final ISequenceInstance instance : sequenceInstances) { + final ISelectionInstance selectionInstance = taskFactory + .createNewTaskInstance(selection); + taskBuilder.setChild(selectionInstance, + instance.get(subTaskIndex)); + taskBuilder.setTaskInstance(instance, subTaskIndex, + selectionInstance); + } + } else if (subTaskVariants.size() == 1) { + taskBuilder.addChild(sequence, subTaskVariants.get(0)); + } + } + } + + /** + *

+ * replaces all occurrences of all tasks provided in the set with iterations + *

+ * + * @param iteratedTasks + * the tasks to be replaced with iterations + * @param sessions + * the sessions in which the tasks are to be replaced + * @param appData + * the rule application data combining all data used for applying + * this rule + */ + private void replaceIterationsOf(Set iteratedTasks, + List sessions, RuleApplicationData appData) { + final Map iterations = new HashMap(); + final Map> iterationInstances = new HashMap>(); + + for (final ITask iteratedTask : iteratedTasks) { + final IIteration iteration = taskFactory.createNewIteration(); + iterations.put(iteratedTask, iteration); + iterationInstances.put(iteration, + new LinkedList()); + } + + IIterationInstance iterationInstance; + + for (final IUserSession session : sessions) { + int index = 0; + iterationInstance = null; + + while (index < session.size()) { + // we prepared the task instances to refer to unique tasks, if + // they are treated + // as equal. Therefore, we just compare the identity of the + // tasks of the task + // instances + final ITask currentTask = session.get(index).getTask(); + final IIteration iteration = iterations.get(currentTask); + if (iteration != null) { + if ((iterationInstance == null) + || (iterationInstance.getTask() != iteration)) { + iterationInstance = taskFactory + .createNewTaskInstance(iteration); + iterationInstances.get(iteration) + .add(iterationInstance); + taskBuilder.addTaskInstance(session, index, + iterationInstance); + index++; + } + + taskBuilder.addChild(iterationInstance, session.get(index)); + taskBuilder.removeTaskInstance(session, index); + } else { + if (iterationInstance != null) { + iterationInstance = null; + } + index++; + } + } + } + + for (final Map.Entry> entry : iterationInstances + .entrySet()) { + harmonizeIterationInstancesModel(entry.getKey(), entry.getValue()); + } + } + + /** + * @param appData + * the rule application data combining all data used for applying + * this rule + */ + private void replaceSequencesOccurringMostOften(RuleApplicationData appData) { + appData.detectedAndReplacedTasks(false); + + if ((appData.getLastFoundTasks().size() > 0) + && (appData.getLastFoundTasks().getOccurrenceCount() > 1)) { + Console.traceln(Level.FINER, "replacing tasks occurrences"); + + for (final List task : appData.getLastFoundTasks()) { + final ISequence sequence = taskFactory.createNewSequence(); + + Console.traceln(Level.FINEST, "replacing " + sequence.getId() + + ": " + task); + + final List sequenceInstances = replaceTaskOccurrences( + task, appData.getSessions(), sequence); + + harmonizeSequenceInstancesModel(sequence, sequenceInstances, + task.size()); + appData.detectedAndReplacedTasks(appData + .detectedAndReplacedTasks() + || (sequenceInstances.size() > 0)); + + if (sequenceInstances.size() < appData.getLastFoundTasks() + .getOccurrenceCount()) { + Console.traceln(Level.FINE, + sequence.getId() + + ": replaced task only " + + sequenceInstances.size() + + " times instead of expected " + + appData.getLastFoundTasks() + .getOccurrenceCount()); + } + } + } + + } + + /** + * @param tree + */ + private List replaceTaskOccurrences( + List task, List sessions, + ISequence temporalTaskModel) { + final List sequenceInstances = new LinkedList(); + + for (final IUserSession session : sessions) { + int index = -1; + + do { + index = getSubListIndex(session, task, ++index); + + if (index > -1) { + sequenceInstances + .add(RuleUtils.createNewSubSequenceInRange(session, + index, (index + task.size()) - 1, + temporalTaskModel, taskFactory, taskBuilder)); + } + } while (index > -1); + } + + return sequenceInstances; + } + + // /** + // * @author Patrick Harms + // */ + // private class TrieStatisticsDumper implements + // TrieProcessor { + // + // /** + // * + // */ + // private Map counters = new HashMap(); + // + // /* (non-Javadoc) + // * @see + // de.ugoe.cs.autoquest.usageprofiles.TrieProcessor#process(java.util.List, + // int) + // */ + // @Override + // public TrieProcessor.Result process(List subsequence, int + // count) { + // if (subsequence.size() == 1) { + // Integer value = counters.get(count); + // + // if (value == null) { + // value = 0; + // } + // + // counters.put(count, value + 1); + // + // return TrieProcessor.Result.CONTINUE; + // } + // else { + // // ignore singular occurrences + // return TrieProcessor.Result.SKIP_NODE; + // } + // } + // + // /** + // * @return + // */ + // public void dumpCounters() { + // int dumpedCounters = 0; + // + // int count = 1; + // while (dumpedCounters < counters.size()) { + // Integer value = counters.get(count++); + // if (value != null) { + // System.out.println(value + " symbols occurred " + count + " times"); + // dumpedCounters++; + // } + // } + // } + // + // } + + /** + *

+ * searches the provided sessions for task iterations. If a task is + * iterated, it is added to the returned set. + *

+ * + * @param the + * session to search for iterations in + * + * @return a set of tasks being iterated somewhere + */ + private Set searchIteratedTasks(List sessions) { + final Set iteratedTasks = new HashSet(); + for (final IUserSession session : sessions) { + for (int i = 0; i < (session.size() - 1); i++) { + // we prepared the task instances to refer to unique tasks, if + // they are treated + // as equal. Therefore, we just compare the identity of the + // tasks of the task + // instances + if (session.get(i).getTask() == session.get(i + 1).getTask()) { + iteratedTasks.add(session.get(i).getTask()); + } + } + } + + return iteratedTasks; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + return "SequenceForTaskDetectionRule"; + } + + // methods for internal testing + // private void checkMatchingOfSessions(List> flattenedSessions, + // List sessions, + // String when) + // { + // List> currentFlattenedSessions = flattenSessions(sessions); + // if (flattenedSessions.size() != currentFlattenedSessions.size()) { + // System.out.println("################## number of sessions changed after " + // + when); + // } + // else { + // for (int i = 0; i < flattenedSessions.size(); i++) { + // List expected = flattenedSessions.get(i); + // List current = currentFlattenedSessions.get(i); + // + // if (expected.size() != current.size()) { + // System.out.println + // ("################## length of session " + i + " changed after " + when); + // } + // else { + // for (int j = 0; j < expected.size(); j++) { + // if (!expected.get(j).equals(current.get(j))) { + // System.out.println("################## event " + j + " of session " + + // i + " changed after " + when); + // } + // } + // } + // } + // } + // } + // + // private List> flattenSessions(List sessions) { + // List> flattenedSessions = new ArrayList>(); + // for (IUserSession session : sessions) { + // List flattenedUserSession = new ArrayList(); + // flatten(session, flattenedUserSession); + // flattenedSessions.add(flattenedUserSession); + // } + // + // return flattenedSessions; + // } + // + // private void flatten(IUserSession iUserSession, List + // flattenedUserSession) { + // for (ITaskInstance instance : iUserSession) { + // flatten(instance, flattenedUserSession); + // } + // } + // + // private void flatten(ITaskInstance instance, List + // flattenedUserSession) { + // if (instance instanceof ITaskInstanceList) { + // for (ITaskInstance child : (ITaskInstanceList) instance) { + // flatten(child, flattenedUserSession); + // } + // } + // else if (instance instanceof ISelectionInstance) { + // flatten(((ISelectionInstance) instance).getChild(), + // flattenedUserSession); + // } + // else if (instance instanceof IOptionalInstance) { + // flatten(((IOptionalInstance) instance).getChild(), flattenedUserSession); + // } + // else if (instance instanceof IEventTaskInstance) { + // flattenedUserSession.add(((IEventTaskInstance) instance).getEvent()); + // } + // } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/SequenceForTaskDetectionRuleAlignment.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/SequenceForTaskDetectionRuleAlignment.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/SequenceForTaskDetectionRuleAlignment.java (revision 1733) @@ -15,5 +15,4 @@ package de.ugoe.cs.autoquest.tasktrees.temporalrelation; -import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; @@ -80,7 +79,359 @@ public class SequenceForTaskDetectionRuleAlignment implements ISessionScopeRule { + private class ParallelMatchOcurrencesFinder implements Runnable { + private final RuleApplicationData appData; + private final int from; + private final int to; + + ParallelMatchOcurrencesFinder(RuleApplicationData appData, int from, + int to) { + this.appData = appData; + this.from = from; + this.to = to; + } + + @Override + public void run() { + int count = 0; + final int size = to - from; + + for (int i = from; i < to; i++) { + final Match pattern = appData.getMatchseqs().get(i); + count++; + RuleUtils.printProgressPercentage("Match finding progress", + count, size); + // Skip sequences with more 0 events (scrolls) than other + // events. + // Both of the pattern sequences are equally long, so the zero + // counts just need to be smaller than the length of one + // sequence + if ((pattern.getFirstSequence().eventCount(0) + + pattern.getSecondSequence().eventCount(0) + 1) > pattern + .getFirstSequence().size()) { + continue; + } + + for (int j = 0; j < appData.getNumberSequences().size(); j++) { + final LinkedList startpositions = appData + .getNumberSequences().get(j) + .containsPattern(pattern); + if (startpositions.size() > 0) { + for (final Iterator jt = startpositions + .iterator(); jt.hasNext();) { + final int start = jt.next(); + pattern.addOccurence(new MatchOccurence(start, + start + pattern.size(), j)); + } + } + } + } + } + } + + private class ParallelMatchReplacer implements Runnable { + + private final RuleApplicationData appData; + private final int from; + private final int to; + + ParallelMatchReplacer(RuleApplicationData appData, int from, int to) { + this.appData = appData; + this.from = from; + this.to = to; + } + + @Override + public void run() { + // TODO Cleanup + // int count = 0; + // int size = to - from; + for (int i = from; i < to; i++) { + // count++; + // Every pattern consists of 2 sequences, therefore the minimum + // occurrences here is 2. + // We just need the sequences also occurring in other sequences + // as well + if (appData.getMatchseqs().get(i).occurenceCount() > 2) { + + final ISequence task = matchAsSequence(appData, appData + .getMatchseqs().get(i)); + invalidOccurence: for (final Iterator it = appData + .getMatchseqs().get(i).getOccurences().iterator(); it + .hasNext();) { + final MatchOccurence oc = it.next(); + + // Check if nothing has been replaced in the sequence we + // want to replace now + + synchronized (appData.getReplacedOccurences()) { + if (appData.getReplacedOccurences().get( + oc.getSequenceId()) == null) { + appData.getReplacedOccurences().put( + oc.getSequenceId(), + new LinkedList()); + } else { + // check if we have any replaced occurence with + // indexes + // smaller than ours. If so, we need to adjust + // our start + // and endpoints + // of the replacement. + // Also do a check if we have replaced this + // specific + // MatchOccurence in this sequence already. Jump + // to the + // next occurence if this is the case. + // This is no more neccessary once the matches + // are + // harmonized. + for (final Iterator jt = appData + .getReplacedOccurences() + .get(oc.getSequenceId()).iterator(); jt + .hasNext();) { + final MatchOccurence tmpOC = jt.next(); + + if ((oc.getStartindex() >= tmpOC + .getStartindex()) + && (oc.getStartindex() <= tmpOC + .getEndindex())) { + continue invalidOccurence; + } + if (oc.getEndindex() >= tmpOC + .getStartindex()) { + continue invalidOccurence; + + } else if (oc.getStartindex() > tmpOC + .getEndindex()) { + final int diff = tmpOC.getEndindex() + - tmpOC.getStartindex(); + // Just to be sure. + if (diff > 0) { + oc.setStartindex((oc + .getStartindex() - diff) + 1); + oc.setEndindex((oc.getEndindex() - diff) + 1); + } else { + Console.traceln(Level.WARNING, + "End index of a Match before start. This should never happen"); + } + } + } + } + System.out.println("Replacing in sequence" + + oc.getSequenceId()); + synchronized (appData) { + appData.detectedAndReplacedTasks = true; + } + synchronized (appData.getSessions().get( + oc.getSequenceId())) { + final ISequenceInstance sequenceInstances = RuleUtils + .createNewSubSequenceInRange( + appData.getSessions().get( + oc.getSequenceId()), + oc.getStartindex(), + oc.getEndindex(), task, + taskFactory, taskBuilder); + oc.setEndindex((oc.getStartindex() + sequenceInstances + .size()) - RuleUtils.missedOptionals); + } + } + // Adjust the length of the match regarding to the + // length of + // instance. (OptionalInstances may be shorter) + + synchronized (appData.getReplacedOccurences().get( + oc.getSequenceId())) { + appData.getReplacedOccurences() + .get(oc.getSequenceId()).add(oc); + } + } + } + } + } + } + + private class ParallelPairwiseAligner implements Runnable { + private final RuleApplicationData appData; + private final int from; + private final int to; + + ParallelPairwiseAligner(RuleApplicationData appData, int from, int to) { + this.appData = appData; + this.from = from; + this.to = to; + } + + @Override + public void run() { + int count = 0; + final int size = to - from; + + for (int i = from; i < to; i++) { + final NumberSequence ns1 = appData.getNumberSequences().get(i); + count++; + RuleUtils.printProgressPercentage("Aligning Progress", count, + size); + for (int j = 0; j < appData.getNumberSequences().size(); j++) { + final NumberSequence ns2 = appData.getNumberSequences() + .get(j); + if (i != j) { + final AlignmentAlgorithm aa = AlignmentAlgorithmFactory + .create(); + aa.align(ns1, ns2, appData.getSubmat(), 9); + synchronized (appData.getMatchseqs()) { + appData.getMatchseqs().addAll(aa.getMatches()); + } + } + } + } + } + } + + /** + * + */ + private static class RuleApplicationData implements Serializable { + + /** + * + */ + private static final long serialVersionUID = -7559657686755522960L; + + private final HashMap number2task; + + // TODO: We Actually just need number2task here, this structure can be + // removed in the future. + private final HashSet uniqueTasks; + + private final ObjectDistanceSubstitionMatrix submat; + + public HashMap> replacedOccurences; + + public LinkedList matchseqs; + + private ArrayList numberseqs; + + private final LinkedList newTasks; + + /** + * + */ + private final List sessions; + + /** + * + */ + private boolean detectedAndReplacedTasks; + + /** + * + */ + private final RuleApplicationResult result; + + /** + * + */ + private final StopWatch stopWatch; + + /** + * + */ + private RuleApplicationData(List sessions) { + this.sessions = sessions; + numberseqs = new ArrayList(); + uniqueTasks = new HashSet(); + number2task = new HashMap(); + stopWatch = new StopWatch(); + result = new RuleApplicationResult(); + submat = new ObjectDistanceSubstitionMatrix(6, -3, false); + newTasks = new LinkedList(); + this.detectedAndReplacedTasks = true; + } + + /** + * + */ + private boolean detectedAndReplacedTasks() { + return detectedAndReplacedTasks; + } + + public LinkedList getMatchseqs() { + return matchseqs; + } + + public LinkedList getNewTasks() { + return newTasks; + } + + private HashMap getNumber2Task() { + return number2task; + } + + private ArrayList getNumberSequences() { + return numberseqs; + } + + public HashMap> getReplacedOccurences() { + return replacedOccurences; + } + + /** + * @return the result + */ + private RuleApplicationResult getResult() { + return result; + } + + /** + * @return the UserSessions as List. + */ + private List getSessions() { + return sessions; + } + + /** + * @return the stopWatch + */ + private StopWatch getStopWatch() { + return stopWatch; + } + + private ObjectDistanceSubstitionMatrix getSubmat() { + return submat; + } + + private HashSet getUniqueTasks() { + return uniqueTasks; + } + + private void newTaskCreated(ITask task) { + number2task.put(task.getId(), task); + newTasks.add(task); + } + + synchronized private void resetNewlyCreatedTasks() { + uniqueTasks.addAll(newTasks); + newTasks.clear(); + } + + private void setNumberSequences(ArrayList numberseqs) { + this.numberseqs = numberseqs; + } + + public void setReplacedOccurences( + HashMap> replacedOccurences) { + this.replacedOccurences = replacedOccurences; + } + + private void updateSubstitutionMatrix() { + submat.update(getNewTasks()); + resetNewlyCreatedTasks(); + } + + } + public static int nThreads = Runtime.getRuntime().availableProcessors() - 1; private int iteration = 0; + /** *

@@ -89,5 +440,6 @@ *

*/ - private ITaskFactory taskFactory; + private final ITaskFactory taskFactory; + /** *

@@ -96,5 +448,5 @@ *

*/ - private ITaskBuilder taskBuilder; + private final ITaskBuilder taskBuilder; /** @@ -104,5 +456,5 @@ *

*/ - private TaskHandlingStrategy preparationTaskHandlingStrategy; + private final TaskHandlingStrategy preparationTaskHandlingStrategy; /** @@ -133,58 +485,4 @@ * (non-Javadoc) * - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - return "SequenceForTaskDetectionRuleAlignment"; - } - - public void saveAppData(String name) { - String objectName = name; - String filename = name + ".dat"; - Object dataObject = GlobalDataContainer.getInstance().getData( - objectName); - if (dataObject == null) { - CommandHelpers.objectNotFoundMessage(objectName); - } - FileOutputStream fos = null; - ObjectOutputStream out = null; - try { - fos = new FileOutputStream(filename); - out = new ObjectOutputStream(fos); - out.writeObject(dataObject); - out.close(); - } catch (IOException ex) { - Console.logException(ex); - } - } - - public RuleApplicationData loadAppData(String name) { - String objectName = name; - String filename = name + ".dat"; - - Object data = null; - FileInputStream fis = null; - ObjectInputStream in = null; - try { - fis = new FileInputStream(filename); - in = new ObjectInputStream(fis); - data = in.readObject(); - in.close(); - } catch (IOException ex) { - Console.logException(ex); - } catch (ClassNotFoundException ex) { - Console.logException(ex); - } - if (GlobalDataContainer.getInstance().addData(objectName, data)) { - CommandHelpers.dataOverwritten(objectName); - } - return (RuleApplicationData) GlobalDataContainer.getInstance().getData( - name); - } - - /* - * (non-Javadoc) - * * @see * de.ugoe.cs.autoquest.tasktrees.temporalrelation.ISessionScopeRule#apply @@ -193,5 +491,5 @@ @Override public RuleApplicationResult apply(List sessions) { - RuleApplicationData appData = new RuleApplicationData(sessions); + final RuleApplicationData appData = new RuleApplicationData(sessions); // File harmonized = new File("harmonized.dat"); // if(harmonized.exists() && !harmonized.isDirectory()) { @@ -232,5 +530,5 @@ detectAndReplaceIterations(appData); appData.getStopWatch().start("task replacement"); - //appData.updateSubstitutionMatrix(); + // appData.updateSubstitutionMatrix(); detectAndReplaceTasks(appData); // appData.getStopWatch().stop("task replacement"); @@ -258,10 +556,10 @@ private ArrayList createNumberSequences( RuleApplicationData appData) { - ArrayList result = new ArrayList(); + final ArrayList result = new ArrayList(); for (int i = 0; i < appData.getSessions().size(); i++) { - IUserSession session = appData.getSessions().get(i); - NumberSequence templist = new NumberSequence(session.size()); + final IUserSession session = appData.getSessions().get(i); + final NumberSequence templist = new NumberSequence(session.size()); for (int j = 0; j < session.size(); j++) { - ITaskInstance taskInstance = session.get(j); + final ITaskInstance taskInstance = session.get(j); templist.getSequence()[j] = taskInstance.getTask().getId(); } @@ -272,4 +570,118 @@ } return result; + } + + /** + *

+ * searches for direct iterations of single tasks in all sequences and + * replaces them with {@link IIteration}s, respectively appropriate + * instances. Also all single occurrences of a task that is iterated + * somewhen are replaced with iterations to have again an efficient way for + * task comparisons. + *

+ * + * @param appData + * the rule application data combining all data used for applying + * this rule + */ + private void detectAndReplaceIterations(RuleApplicationData appData) { + Console.traceln(Level.FINE, "detecting iterations"); + appData.getStopWatch().start("detecting iterations"); + + final List sessions = appData.getSessions(); + + final Set iteratedTasks = searchIteratedTasks(sessions); + + if (iteratedTasks.size() > 0) { + replaceIterationsOf(iteratedTasks, sessions, appData); + } + + appData.getStopWatch().stop("detecting iterations"); + Console.traceln(Level.INFO, "replaced " + iteratedTasks.size() + + " iterated tasks"); + } + + /** + * + * @param appData + * the rule application data combining all data used for applying + * this rule + */ + private void detectAndReplaceTasks(RuleApplicationData appData) { + Console.traceln(Level.FINE, "detecting and replacing tasks"); + appData.getStopWatch().start("detecting tasks"); + + // Create NumberSequences + appData.setNumberSequences(this.createNumberSequences(appData)); + + // Generate pairwise alignments + // appData.setMatchseqs(generatePairwiseAlignments(appData)); + generatePairwiseAlignments(appData); + + // Searching each match in all other sessions, counting its occurences + searchMatchesInAllSessions(appData); + + // Sort results to get the most occurring results + Console.traceln(Level.INFO, "sorting " + appData.getMatchseqs().size() + + " results"); + final Comparator comparator = new Comparator() { + @Override + public int compare(Match m1, Match m2) { + return m2.occurenceCount() - m1.occurenceCount(); + + } + }; + + Collections.sort(appData.getMatchseqs(), comparator); + appData.getStopWatch().stop("detecting tasks"); + + // Replace matches in the sessions + Console.traceln(Level.INFO, "Replacing matches in sessions"); + replaceMatches(appData); + appData.getStopWatch().start("replacing tasks"); + + // appData.setMatchseqs(null); + appData.getStopWatch().stop("replacing tasks"); + } + + // private LinkedList generatePairwiseAlignments(RuleApplicationData + // appData) { + private void generatePairwiseAlignments(RuleApplicationData appData) { + final int numberSeqSize = appData.getNumberSequences().size(); + appData.matchseqs = new LinkedList(); + Console.traceln(Level.INFO, "generating pairwise alignments from " + + numberSeqSize + " sessions with " + nThreads + " threads"); + + int newThreads = nThreads; + if (numberSeqSize < nThreads) { + newThreads = numberSeqSize; + } + + final ExecutorService executor = Executors + .newFixedThreadPool(newThreads); + final int interval = numberSeqSize / newThreads; + int rest = numberSeqSize % newThreads; + + for (int i = 0; i < (numberSeqSize - interval); i += interval) { + int offset = 0; + if (rest != 0) { + offset = 1; + rest--; + } + final int from = i; + final int to = i + interval + offset; + System.out.println("Creating thread for sessions " + from + + " till " + to); + final ParallelPairwiseAligner aligner = new ParallelPairwiseAligner( + appData, from, to); + executor.execute(aligner); + } + executor.shutdown(); + try { + executor.awaitTermination(2, TimeUnit.HOURS); + } catch (final InterruptedException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } } @@ -291,18 +703,18 @@ "harmonizing task model of event task instances"); appData.getStopWatch().start("harmonizing event tasks"); - SymbolMap uniqueTasks = preparationTaskHandlingStrategy + final SymbolMap uniqueTasks = preparationTaskHandlingStrategy .createSymbolMap(); - TaskInstanceComparator comparator = preparationTaskHandlingStrategy + final TaskInstanceComparator comparator = preparationTaskHandlingStrategy .getTaskComparator(); int unifiedTasks = 0; ITask task; - List sessions = appData.getSessions(); + final List sessions = appData.getSessions(); for (int j = 0; j < sessions.size(); j++) { - IUserSession session = sessions.get(j); + final IUserSession session = sessions.get(j); for (int i = 0; i < session.size(); i++) { - ITaskInstance taskInstance = session.get(i); + final ITaskInstance taskInstance = session.get(i); task = uniqueTasks.getValue(taskInstance); @@ -332,58 +744,208 @@ /** *

- * searches for direct iterations of single tasks in all sequences and - * replaces them with {@link IIteration}s, respectively appropriate - * instances. Also all single occurrences of a task that is iterated - * somewhen are replaced with iterations to have again an efficient way for - * task comparisons. + * TODO clarify why this is done *

- * + */ + private void harmonizeIterationInstancesModel(IIteration iteration, + List iterationInstances) { + final List iteratedTaskVariants = new LinkedList(); + final TaskInstanceComparator comparator = preparationTaskHandlingStrategy + .getTaskComparator(); + + // merge the lexically different variants of iterated task to a unique + // list + for (final IIterationInstance iterationInstance : iterationInstances) { + for (final ITaskInstance executionVariant : iterationInstance) { + final ITask candidate = executionVariant.getTask(); + + boolean found = false; + for (final ITask taskVariant : iteratedTaskVariants) { + if (comparator.areLexicallyEqual(taskVariant, candidate)) { + taskBuilder.setTask(executionVariant, taskVariant); + found = true; + break; + } + } + + if (!found) { + iteratedTaskVariants.add(candidate); + } + } + } + + // if there are more than one lexically different variant of iterated + // tasks, adapt the + // iteration model to be a selection of different variants. In this case + // also adapt + // the generated iteration instances to correctly contain selection + // instances. If there + // is only one variant of an iterated task, simply set this as the + // marked task of the + // iteration. In this case, the instances can be preserved as is + if (iteratedTaskVariants.size() > 1) { + final ISelection selection = taskFactory.createNewSelection(); + + for (final ITask variant : iteratedTaskVariants) { + taskBuilder.addChild(selection, variant); + } + + taskBuilder.setMarkedTask(iteration, selection); + + for (final IIterationInstance instance : iterationInstances) { + for (int i = 0; i < instance.size(); i++) { + final ISelectionInstance selectionInstance = taskFactory + .createNewTaskInstance(selection); + taskBuilder.setChild(selectionInstance, instance.get(i)); + taskBuilder.setTaskInstance(instance, i, selectionInstance); + } + } + } else { + taskBuilder.setMarkedTask(iteration, iteratedTaskVariants.get(0)); + } + } + + public RuleApplicationData loadAppData(String name) { + final String objectName = name; + final String filename = name + ".dat"; + + Object data = null; + FileInputStream fis = null; + ObjectInputStream in = null; + try { + fis = new FileInputStream(filename); + in = new ObjectInputStream(fis); + data = in.readObject(); + in.close(); + } catch (final IOException ex) { + Console.logException(ex); + } catch (final ClassNotFoundException ex) { + Console.logException(ex); + } + if (GlobalDataContainer.getInstance().addData(objectName, data)) { + CommandHelpers.dataOverwritten(objectName); + } + return (RuleApplicationData) GlobalDataContainer.getInstance().getData( + name); + } + + /** * @param appData - * the rule application data combining all data used for applying - * this rule - */ - private void detectAndReplaceIterations(RuleApplicationData appData) { - Console.traceln(Level.FINE, "detecting iterations"); - appData.getStopWatch().start("detecting iterations"); - - List sessions = appData.getSessions(); - - Set iteratedTasks = searchIteratedTasks(sessions); - - if (iteratedTasks.size() > 0) { - replaceIterationsOf(iteratedTasks, sessions, appData); - } - - appData.getStopWatch().stop("detecting iterations"); - Console.traceln(Level.INFO, "replaced " + iteratedTasks.size() - + " iterated tasks"); - } - - /** - *

- * searches the provided sessions for task iterations. If a task is - * iterated, it is added to the returned set. - *

- * - * @param the - * session to search for iterations in - * - * @return a set of tasks being iterated somewhere - */ - private Set searchIteratedTasks(List sessions) { - Set iteratedTasks = new HashSet(); - for (IUserSession session : sessions) { - for (int i = 0; i < (session.size() - 1); i++) { - // we prepared the task instances to refer to unique tasks, if - // they are treated - // as equal. Therefore, we just compare the identity of the - // tasks of the task - // instances - if (session.get(i).getTask() == session.get(i + 1).getTask()) { - iteratedTasks.add(session.get(i).getTask()); + * , Ruleapplication Data needed to keep track of all created + * tasks + * @param m + * The match to be converted into a Task + * @return The task of the match with an ISequence as it's root + */ + synchronized public ISequence matchAsSequence(RuleApplicationData appData, + Match m) { + final ISequence sequence = taskFactory.createNewSequence(); + appData.newTaskCreated(sequence); + + final int[] first = m.getFirstSequence().getSequence(); + final int[] second = m.getSecondSequence().getSequence(); + + // Both sequences of a match are equally long + for (int i = 0; i < m.getFirstSequence().size(); i++) { + + // Two gaps aligned to each other: Have not seen it happening so + // far, just to handle it + if ((first[i] == -1) && (second[i] == -1)) { + // Do nothing here. + } + // Both events are equal, we can simply add the task referring to + // the number + else if (first[i] == second[i]) { + taskBuilder.addChild(sequence, + appData.getNumber2Task().get(first[i])); + } + // We have a gap in the first sequence, we need to add the task of + // the second sequence as optional + else if ((first[i] == -1) && (second[i] != -1)) { + final IOptional optional = taskFactory.createNewOptional(); + appData.newTaskCreated(optional); + taskBuilder.setMarkedTask(optional, appData.getNumber2Task() + .get(second[i])); + taskBuilder.addChild(sequence, optional); + } + // We have a gap in the second sequence, we need to add the task of + // the first sequence as optional + else if ((first[i] != -1) && (second[i] == -1)) { + final IOptional optional = taskFactory.createNewOptional(); + appData.newTaskCreated(optional); + taskBuilder.setMarkedTask(optional, appData.getNumber2Task() + .get(first[i])); + taskBuilder.addChild(sequence, optional); + } + // Both tasks are not equal, we need to insert a selection here. + // Check if the next position is not a selection + else if (i < (first.length - 1)) { + + if ((first[i] != second[i]) + && (((first[i + 1] == second[i + 1]) + || (first[i + 1] == -1) || (second[i + 1] == -1)))) { + + final ISelection selection = taskFactory + .createNewSelection(); + appData.newTaskCreated(selection); + taskBuilder.addChild(selection, appData.getNumber2Task() + .get(first[i])); + taskBuilder.addChild(selection, appData.getNumber2Task() + .get(second[i])); + taskBuilder.addChild(sequence, selection); + } else { + boolean selectionfound = true; + final ISelection selection = taskFactory + .createNewSelection(); + appData.newTaskCreated(selection); + + final ISequence subsequence1 = taskFactory + .createNewSequence(); + appData.newTaskCreated(subsequence1); + + final ISequence subsequence2 = taskFactory + .createNewSequence(); + appData.newTaskCreated(subsequence2); + + taskBuilder.addChild(selection, subsequence1); + taskBuilder.addChild(selection, subsequence2); + taskBuilder.addChild(sequence, selection); + while ((i < (first.length - 1)) && selectionfound) { + selectionfound = false; + taskBuilder.addChild(subsequence1, appData + .getNumber2Task().get(first[i])); + taskBuilder.addChild(subsequence2, appData + .getNumber2Task().get(second[i])); + if ((first[i + 1] != second[i + 1]) + && (first[i + 1] != -1) + && (second[i + 1] != -1)) { + selectionfound = true; + } else { + continue; + } + i++; + } + if ((i == (first.length - 1)) && selectionfound) { + taskBuilder.addChild(subsequence1, appData + .getNumber2Task().get(first[i])); + taskBuilder.addChild(subsequence2, appData + .getNumber2Task().get(second[i])); + } } - } - } - return iteratedTasks; + } else { + if ((first[i] != second[i])) { + + final ISelection selection = taskFactory + .createNewSelection(); + appData.newTaskCreated(selection); + taskBuilder.addChild(selection, appData.getNumber2Task() + .get(first[i])); + taskBuilder.addChild(selection, appData.getNumber2Task() + .get(second[i])); + taskBuilder.addChild(sequence, selection); + } + } + + } + return sequence; } @@ -403,10 +965,10 @@ private void replaceIterationsOf(Set iteratedTasks, List sessions, RuleApplicationData appData) { - Map iterations = new HashMap(); - Map> iterationInstances = new HashMap>(); - - for (ITask iteratedTask : iteratedTasks) { - - IIteration iteration = taskFactory.createNewIteration(); + final Map iterations = new HashMap(); + final Map> iterationInstances = new HashMap>(); + + for (final ITask iteratedTask : iteratedTasks) { + + final IIteration iteration = taskFactory.createNewIteration(); appData.newTaskCreated(iteration); iterations.put(iteratedTask, iteration); @@ -417,5 +979,5 @@ IIterationInstance iterationInstance; - for (IUserSession session : sessions) { + for (final IUserSession session : sessions) { int index = 0; iterationInstance = null; @@ -427,6 +989,6 @@ // tasks of the task // instances - ITask currentTask = session.get(index).getTask(); - IIteration iteration = iterations.get(currentTask); + final ITask currentTask = session.get(index).getTask(); + final IIteration iteration = iterations.get(currentTask); if (iteration != null) { if ((iterationInstance == null) @@ -436,7 +998,7 @@ iterationInstances.get(iteration) .add(iterationInstance);// TODO:: Don't create - // TaskInstances here, - // use a set of tasks - // instead + // TaskInstances here, + // use a set of tasks + // instead taskBuilder.addTaskInstance(session, index, iterationInstance); @@ -455,5 +1017,5 @@ } - for (Map.Entry> entry : iterationInstances + for (final Map.Entry> entry : iterationInstances .entrySet()) { harmonizeIterationInstancesModel(entry.getKey(), entry.getValue()); @@ -461,233 +1023,18 @@ } - /** - *

- * TODO clarify why this is done - *

- */ - private void harmonizeIterationInstancesModel(IIteration iteration, - List iterationInstances) { - List iteratedTaskVariants = new LinkedList(); - TaskInstanceComparator comparator = preparationTaskHandlingStrategy - .getTaskComparator(); - - // merge the lexically different variants of iterated task to a unique - // list - for (IIterationInstance iterationInstance : iterationInstances) { - for (ITaskInstance executionVariant : iterationInstance) { - ITask candidate = executionVariant.getTask(); - - boolean found = false; - for (ITask taskVariant : iteratedTaskVariants) { - if (comparator.areLexicallyEqual(taskVariant, candidate)) { - taskBuilder.setTask(executionVariant, taskVariant); - found = true; - break; - } - } - - if (!found) { - iteratedTaskVariants.add(candidate); - } - } - } - - // if there are more than one lexically different variant of iterated - // tasks, adapt the - // iteration model to be a selection of different variants. In this case - // also adapt - // the generated iteration instances to correctly contain selection - // instances. If there - // is only one variant of an iterated task, simply set this as the - // marked task of the - // iteration. In this case, the instances can be preserved as is - if (iteratedTaskVariants.size() > 1) { - ISelection selection = taskFactory.createNewSelection(); - - for (ITask variant : iteratedTaskVariants) { - taskBuilder.addChild(selection, variant); - } - - taskBuilder.setMarkedTask(iteration, selection); - - for (IIterationInstance instance : iterationInstances) { - for (int i = 0; i < instance.size(); i++) { - ISelectionInstance selectionInstance = taskFactory - .createNewTaskInstance(selection); - taskBuilder.setChild(selectionInstance, instance.get(i)); - taskBuilder.setTaskInstance(instance, i, selectionInstance); - } - } - } else { - taskBuilder.setMarkedTask(iteration, iteratedTaskVariants.get(0)); - } - } - - /** - * @param appData - * @param m - * @return - */ - synchronized public ISequence matchAsSequence(RuleApplicationData appData, Match m) { - ISequence sequence = taskFactory.createNewSequence(); - appData.newTaskCreated(sequence); - - int[] first = m.getFirstSequence().getSequence(); - int[] second = m.getSecondSequence().getSequence(); - - // Both sequences of a match are equally long - for (int i = 0; i < m.getFirstSequence().size(); i++) { - - // Two gaps aligned to each other: Have not seen it happening so - // far, just to handle it - if (first[i] == -1 && second[i] == -1) { - // Do nothing here. - } - // Both events are equal, we can simply add the task referring to - // the number - else if (first[i] == second[i]) { - taskBuilder.addChild(sequence, - appData.getNumber2Task().get(first[i])); - } - // We have a gap in the first sequence, we need to add the task of - // the second sequence as optional - else if (first[i] == -1 && second[i] != -1) { - IOptional optional = taskFactory.createNewOptional(); - appData.newTaskCreated(optional); - taskBuilder.setMarkedTask(optional, appData.getNumber2Task() - .get(second[i])); - taskBuilder.addChild(sequence, optional); - } - // We have a gap in the second sequence, we need to add the task of - // the first sequence as optional - else if (first[i] != -1 && second[i] == -1) { - IOptional optional = taskFactory.createNewOptional(); - appData.newTaskCreated(optional); - taskBuilder.setMarkedTask(optional, appData.getNumber2Task() - .get(first[i])); - taskBuilder.addChild(sequence, optional); - } - // Both tasks are not equal, we need to insert a selection here. - // Check if the next position is not a selection - else if (i < first.length - 1) { - - if ((first[i] != second[i]) - && ((first[i + 1] == second[i + 1] - || first[i + 1] == -1 || second[i + 1] == -1))) { - - ISelection selection = taskFactory.createNewSelection(); - appData.newTaskCreated(selection); - taskBuilder.addChild(selection, appData.getNumber2Task() - .get(first[i])); - taskBuilder.addChild(selection, appData.getNumber2Task() - .get(second[i])); - taskBuilder.addChild(sequence, selection); - } else { - boolean selectionfound = true; - ISelection selection = taskFactory.createNewSelection(); - appData.newTaskCreated(selection); - - ISequence subsequence1 = taskFactory.createNewSequence(); - appData.newTaskCreated(subsequence1); - - ISequence subsequence2 = taskFactory.createNewSequence(); - appData.newTaskCreated(subsequence2); - - taskBuilder.addChild(selection, subsequence1); - taskBuilder.addChild(selection, subsequence2); - taskBuilder.addChild(sequence, selection); - while (i < first.length - 1 && selectionfound) { - selectionfound = false; - taskBuilder.addChild(subsequence1, appData - .getNumber2Task().get(first[i])); - taskBuilder.addChild(subsequence2, appData - .getNumber2Task().get(second[i])); - if (first[i + 1] != second[i + 1] && first[i + 1] != -1 - && second[i + 1] != -1) { - selectionfound = true; - } else { - continue; - } - i++; - } - if (i == first.length - 1 && selectionfound) { - taskBuilder.addChild(subsequence1, appData - .getNumber2Task().get(first[i])); - taskBuilder.addChild(subsequence2, appData - .getNumber2Task().get(second[i])); - } - } - } else { - if ((first[i] != second[i])) { - - ISelection selection = taskFactory.createNewSelection(); - appData.newTaskCreated(selection); - taskBuilder.addChild(selection, appData.getNumber2Task() - .get(first[i])); - taskBuilder.addChild(selection, appData.getNumber2Task() - .get(second[i])); - taskBuilder.addChild(sequence, selection); - } - } - - } - return sequence; - } - - /** - * - * @param appData - * the rule application data combining all data used for applying - * this rule - */ - private void detectAndReplaceTasks(RuleApplicationData appData) { - Console.traceln(Level.FINE, "detecting and replacing tasks"); - appData.getStopWatch().start("detecting tasks"); - - // Create NumberSequences - appData.setNumberSequences(this.createNumberSequences(appData)); - - // Generate pairwise alignments - // appData.setMatchseqs(generatePairwiseAlignments(appData)); - generatePairwiseAlignments(appData); - - // Searching each match in all other sessions, counting its occurences - searchMatchesInAllSessions(appData); - - // Sort results to get the most occurring results - Console.traceln(Level.INFO, "sorting " + appData.getMatchseqs().size() - + " results"); - Comparator comparator = new Comparator() { - public int compare(Match m1, Match m2) { - return m2.occurenceCount() - m1.occurenceCount(); - - } - }; - - Collections.sort(appData.getMatchseqs(), comparator); - appData.getStopWatch().stop("detecting tasks"); - - // Replace matches in the sessions - Console.traceln(Level.INFO, "Replacing matches in sessions"); - replaceMatches(appData); - appData.getStopWatch().start("replacing tasks"); - - // appData.setMatchseqs(null); - appData.getStopWatch().stop("replacing tasks"); - } - private void replaceMatches(RuleApplicationData appData) { appData.replacedOccurences = new HashMap>(); - - int matchSeqSize = appData.getMatchseqs().size(); + + final int matchSeqSize = appData.getMatchseqs().size(); int newThreads = nThreads; if (matchSeqSize < nThreads) { - newThreads = matchSeqSize; - } - ExecutorService executor = Executors.newFixedThreadPool(newThreads); - int interval = matchSeqSize / newThreads; + newThreads = matchSeqSize; + } + final ExecutorService executor = Executors + .newFixedThreadPool(newThreads); + final int interval = matchSeqSize / newThreads; int rest = matchSeqSize % newThreads; - - for (int i = 0; i < matchSeqSize - interval; i += interval) { + + for (int i = 0; i < (matchSeqSize - interval); i += interval) { int offset = 0; if (rest != 0) { @@ -695,10 +1042,11 @@ rest--; } - int from = i; - int to = i + interval + offset; - System.out.println("Replacement: Creating thread with matches from " + from - + " to " + to); + final int from = i; + final int to = i + interval + offset; + System.out + .println("Replacement: Creating thread with matches from " + + from + " to " + to); // search each match in every other sequence - ParallelMatchReplacer replacer = new ParallelMatchReplacer( + final ParallelMatchReplacer replacer = new ParallelMatchReplacer( appData, from, to); executor.execute(replacer); @@ -707,8 +1055,56 @@ try { executor.awaitTermination(2, TimeUnit.HOURS); - } catch (InterruptedException e) { + } catch (final InterruptedException e) { // TODO Auto-generated catch block e.printStackTrace(); } + } + + public void saveAppData(String name) { + final String objectName = name; + final String filename = name + ".dat"; + final Object dataObject = GlobalDataContainer.getInstance().getData( + objectName); + if (dataObject == null) { + CommandHelpers.objectNotFoundMessage(objectName); + } + FileOutputStream fos = null; + ObjectOutputStream out = null; + try { + fos = new FileOutputStream(filename); + out = new ObjectOutputStream(fos); + out.writeObject(dataObject); + out.close(); + } catch (final IOException ex) { + Console.logException(ex); + } + } + + /** + *

+ * searches the provided sessions for task iterations. If a task is + * iterated, it is added to the returned set. + *

+ * + * @param the + * session to search for iterations in + * + * @return a set of tasks being iterated somewhere + */ + private Set searchIteratedTasks(List sessions) { + final Set iteratedTasks = new HashSet(); + for (final IUserSession session : sessions) { + for (int i = 0; i < (session.size() - 1); i++) { + // we prepared the task instances to refer to unique tasks, if + // they are treated + // as equal. Therefore, we just compare the identity of the + // tasks of the task + // instances + if (session.get(i).getTask() == session.get(i + 1).getTask()) { + iteratedTasks.add(session.get(i).getTask()); + } + } + } + return iteratedTasks; } @@ -718,15 +1114,15 @@ + " threads"); // Prepare parallel search of matchseqs - - int matchSeqSize = appData.getMatchseqs().size(); + + final int matchSeqSize = appData.getMatchseqs().size(); int newThreads = nThreads; if (matchSeqSize < nThreads) { - newThreads = matchSeqSize; - } - int interval = matchSeqSize / newThreads; + newThreads = matchSeqSize; + } + final int interval = matchSeqSize / newThreads; int rest = matchSeqSize % newThreads; - ExecutorService executor = Executors.newFixedThreadPool(nThreads); - - for (int i = 0; i < matchSeqSize - interval; i += interval) { + final ExecutorService executor = Executors.newFixedThreadPool(nThreads); + + for (int i = 0; i < (matchSeqSize - interval); i += interval) { int offset = 0; if (rest != 0) { @@ -734,10 +1130,11 @@ rest--; } - int from = i; - int to = i + interval + offset; - System.out.println("Match finding: Creating thread with matches from " + from - + " to " + to); + final int from = i; + final int to = i + interval + offset; + System.out + .println("Match finding: Creating thread with matches from " + + from + " to " + to); // search each match in every other sequence - ParallelMatchOcurrencesFinder finder = new ParallelMatchOcurrencesFinder( + final ParallelMatchOcurrencesFinder finder = new ParallelMatchOcurrencesFinder( appData, from, to); executor.execute(finder); @@ -746,5 +1143,5 @@ try { executor.awaitTermination(2, TimeUnit.HOURS); - } catch (InterruptedException e) { + } catch (final InterruptedException e) { // TODO Auto-generated catch block e.printStackTrace(); @@ -753,376 +1150,12 @@ } - - private class ParallelMatchReplacer implements Runnable { - - private final RuleApplicationData appData; - private final int from; - private final int to; - - ParallelMatchReplacer(RuleApplicationData appData, int from, - int to) { - this.appData = appData; - this.from = from; - this.to = to; - } - @Override - public void run() { - int count = 0; - int size = to - from; - for (int i = from; i < to; i++) { - count++; - // Every pattern consists of 2 sequences, therefore the minimum - // occurrences here is 2. - // We just need the sequences also occurring in other sequences as well - if (appData.getMatchseqs().get(i).occurenceCount() > 2) { - - ISequence task = matchAsSequence(appData, appData.getMatchseqs().get(i)); - invalidOccurence: for (Iterator it = appData - .getMatchseqs().get(i).getOccurences().iterator(); it - .hasNext();) { - MatchOccurence oc = it.next(); - - // Check if nothing has been replaced in the sequence we - // want to replace now - - synchronized (appData.getReplacedOccurences()) { - if (appData.getReplacedOccurences().get(oc.getSequenceId()) == null) { - appData.getReplacedOccurences().put(oc.getSequenceId(), - new LinkedList()); - } else { - // check if we have any replaced occurence with indexes - // smaller than ours. If so, we need to adjust our start - // and endpoints - // of the replacement. - // Also do a check if we have replaced this specific - // MatchOccurence in this sequence already. Jump to the - // next occurence if this is the case. - // This is no more neccessary once the matches are - // harmonized. - for (Iterator jt = appData.getReplacedOccurences() - .get(oc.getSequenceId()).iterator(); jt - .hasNext();) { - MatchOccurence tmpOC = jt.next(); - - if (oc.getStartindex() >= tmpOC.getStartindex() - && oc.getStartindex() <= tmpOC - .getEndindex()) { - continue invalidOccurence; - } - if (oc.getEndindex() >= tmpOC.getStartindex()) { - continue invalidOccurence; - - } else if (oc.getStartindex() > tmpOC.getEndindex()) { - int diff = tmpOC.getEndindex() - - tmpOC.getStartindex(); - // Just to be sure. - if (diff > 0) { - oc.setStartindex(oc.getStartindex() - diff - + 1); - oc.setEndindex(oc.getEndindex() - diff + 1); - } else { - Console.traceln(Level.WARNING, - "End index of a Match before start. This should never happen"); - } - } - } - } - System.out.println("Replacing in sequence" - + oc.getSequenceId()); - synchronized(appData) { - appData.detectedAndReplacedTasks = true; - } - synchronized (appData.getSessions().get(oc.getSequenceId())) { - ISequenceInstance sequenceInstances = RuleUtils - .createNewSubSequenceInRange(appData.getSessions() - .get(oc.getSequenceId()), oc - .getStartindex(), oc.getEndindex(), task, - taskFactory, taskBuilder); - oc.setEndindex(oc.getStartindex() - + sequenceInstances.size() - - RuleUtils.missedOptionals); - } - } - // Adjust the length of the match regarding to the length of - // instance. (OptionalInstances may be shorter) - - synchronized(appData.getReplacedOccurences().get(oc.getSequenceId())) { - appData.getReplacedOccurences().get(oc.getSequenceId()).add(oc); - } - } - } - } - } - } - - - - private class ParallelMatchOcurrencesFinder implements Runnable { - private final RuleApplicationData appData; - private final int from; - private final int to; - - ParallelMatchOcurrencesFinder(RuleApplicationData appData, int from, - int to) { - this.appData = appData; - this.from = from; - this.to = to; - } - - @Override - public void run() { - int count = 0; - int size = to - from; - - for (int i = from; i < to; i++) { - Match pattern = appData.getMatchseqs().get(i); - count++; - RuleUtils.printProgressPercentage("Match finding progress",count, size); - // Skip sequences with more 0 events (scrolls) than other - // events. - // Both of the pattern sequences are equally long, so the zero - // counts just need to be smaller than the length of one - // sequence - if (pattern.getFirstSequence().eventCount(0) - + pattern.getSecondSequence().eventCount(0) + 1 > pattern - .getFirstSequence().size()) - continue; - - for (int j = 0; j < appData.getNumberSequences().size(); j++) { - LinkedList startpositions = appData - .getNumberSequences().get(j) - .containsPattern(pattern); - if (startpositions.size() > 0) { - for (Iterator jt = startpositions.iterator(); jt - .hasNext();) { - int start = jt.next(); - pattern.addOccurence(new MatchOccurence(start, - start + pattern.size(), j)); - } - } - } - } - } - } - - private class ParallelPairwiseAligner implements Runnable { - private final RuleApplicationData appData; - private final int from; - private final int to; - - ParallelPairwiseAligner(RuleApplicationData appData, int from, int to) { - this.appData = appData; - this.from = from; - this.to = to; - } - - @Override - public void run() { - int count = 0; - int size = to - from; - - for (int i = from; i < to; i++) { - NumberSequence ns1 = appData.getNumberSequences().get(i); - count++; - RuleUtils.printProgressPercentage("Aligning Progress",count, size); - for (int j = 0; j < appData.getNumberSequences().size(); j++) { - NumberSequence ns2 = appData.getNumberSequences().get(j); - if (i != j) { - AlignmentAlgorithm aa = AlignmentAlgorithmFactory - .create(); - aa.align(ns1, ns2, appData.getSubmat(), 9); - synchronized (appData.getMatchseqs()) { - appData.getMatchseqs().addAll(aa.getMatches()); - } - } - } - } - } - } - - // private LinkedList generatePairwiseAlignments(RuleApplicationData - // appData) { - private void generatePairwiseAlignments(RuleApplicationData appData) { - int numberSeqSize = appData.getNumberSequences().size(); - appData.matchseqs = new LinkedList(); - Console.traceln(Level.INFO, "generating pairwise alignments from " - + numberSeqSize + " sessions with " + nThreads + " threads"); - - int newThreads = nThreads; - if (numberSeqSize < nThreads) { - newThreads = numberSeqSize; - } - - ExecutorService executor = Executors.newFixedThreadPool(newThreads); - int interval = numberSeqSize / newThreads; - int rest = numberSeqSize % newThreads; - - for (int i = 0; i < numberSeqSize - interval; i += interval) { - int offset = 0; - if (rest != 0) { - offset = 1; - rest--; - } - int from = i; - int to = i + interval + offset; - System.out.println("Creating thread for sessions " + from - + " till " + to); - ParallelPairwiseAligner aligner = new ParallelPairwiseAligner( - appData, from, to); - executor.execute(aligner); - } - executor.shutdown(); - try { - executor.awaitTermination(2, TimeUnit.HOURS); - } catch (InterruptedException e) { - // TODO Auto-generated catch block - e.printStackTrace(); - } - } - - /** - * - */ - private static class RuleApplicationData implements Serializable { - - /** - * - */ - private static final long serialVersionUID = -7559657686755522960L; - - private HashMap number2task; - - // TODO: We Actually just need number2task here, this structure can be - // removed in the future. - private HashSet uniqueTasks; - - private ObjectDistanceSubstitionMatrix submat; - - public HashMap> replacedOccurences; - - - public LinkedList matchseqs; - - private ArrayList numberseqs; - - private LinkedList newTasks; - - /** - * - */ - private List sessions; - - /** - * - */ - private boolean detectedAndReplacedTasks; - - /** - * - */ - private RuleApplicationResult result; - - /** - * - */ - private StopWatch stopWatch; - - /** - * - */ - private RuleApplicationData(List sessions) { - this.sessions = sessions; - numberseqs = new ArrayList(); - uniqueTasks = new HashSet(); - number2task = new HashMap(); - stopWatch = new StopWatch(); - result = new RuleApplicationResult(); - submat = new ObjectDistanceSubstitionMatrix(6, -3, false); - newTasks = new LinkedList(); - this.detectedAndReplacedTasks = true; - } - - public LinkedList getMatchseqs() { - return matchseqs; - } - - private ObjectDistanceSubstitionMatrix getSubmat() { - return submat; - } - - synchronized private void resetNewlyCreatedTasks() { - uniqueTasks.addAll(newTasks); - newTasks.clear(); - } - - private void newTaskCreated(ITask task) { - number2task.put(task.getId(), task); - newTasks.add(task); - } - - /** - * @return the UserSessions as List. - */ - private List getSessions() { - return sessions; - } - - - public HashMap> getReplacedOccurences() { - return replacedOccurences; - } - - public void setReplacedOccurences( - HashMap> replacedOccurences) { - this.replacedOccurences = replacedOccurences; - } - - - private HashSet getUniqueTasks() { - return uniqueTasks; - } - - private void setNumberSequences(ArrayList numberseqs) { - this.numberseqs = numberseqs; - } - - private ArrayList getNumberSequences() { - return numberseqs; - } - - private void updateSubstitutionMatrix() { - submat.update(getNewTasks()); - resetNewlyCreatedTasks(); - } - - /** - * - */ - private boolean detectedAndReplacedTasks() { - return detectedAndReplacedTasks; - } - - /** - * @return the result - */ - private RuleApplicationResult getResult() { - return result; - } - - public LinkedList getNewTasks() { - return newTasks; - } - - /** - * @return the stopWatch - */ - private StopWatch getStopWatch() { - return stopWatch; - } - - private HashMap getNumber2Task() { - return number2task; - } - + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + return "SequenceForTaskDetectionRuleAlignment"; } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskHandlingStrategy.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskHandlingStrategy.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskHandlingStrategy.java (revision 1733) @@ -24,8 +24,9 @@ *

* concrete implementation of a symbol strategy required in the creation of a - * {@link de.ugoe.cs.autoquest.usageprofiles.Trie}. The strategy can be parameterized with a - * considered task equality. It uses task instance comparators to perform task comparison. - * It creates task specific symbol maps, which are {@link TaskSymbolIdentityMap} and - * {@link TaskSymbolBucketedMap} depending on the level of considered task equality. + * {@link de.ugoe.cs.autoquest.usageprofiles.Trie}. The strategy can be + * parameterized with a considered task equality. It uses task instance + * comparators to perform task comparison. It creates task specific symbol maps, + * which are {@link TaskSymbolIdentityMap} and {@link TaskSymbolBucketedMap} + * depending on the level of considered task equality. *

* @@ -33,83 +34,92 @@ */ public class TaskHandlingStrategy implements SymbolStrategy { - - /** */ - private static final long serialVersionUID = 1L; - /** - *

- * the level of task equality considered in this task handling strategy - *

- */ - private TaskEquality consideredEquality; + /** */ + private static final long serialVersionUID = 1L; - /** - *

- * the comparator used for task comparisons - *

- */ - private TaskInstanceComparator comparator; + /** + *

+ * the level of task equality considered in this task handling strategy + *

+ */ + private final TaskEquality consideredEquality; - /** - *

- * initializes this strategy with a task equality to be considered for task comparisons - * g

- * - * @param consideredEquality the task equality to be considered for task comparisons - */ - public TaskHandlingStrategy(TaskEquality consideredEquality) { - this.consideredEquality = consideredEquality; - - if (this.consideredEquality == TaskEquality.IDENTICAL) { - comparator = new TaskIdentityComparator(); - } - else { - comparator = new TaskInstanceComparator(this.consideredEquality); - } - } + /** + *

+ * the comparator used for task comparisons + *

+ */ + private TaskInstanceComparator comparator; - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolStrategy#getSymbolComparator() - */ - @Override - public SymbolComparator getSymbolComparator() { - return comparator; - } + /** + *

+ * initializes this strategy with a task equality to be considered for task + * comparisons g + *

+ * + * @param consideredEquality + * the task equality to be considered for task comparisons + */ + public TaskHandlingStrategy(TaskEquality consideredEquality) { + this.consideredEquality = consideredEquality; - /** - *

- * convenience method to have a correctly typed return value as alternative to - * {@link #getSymbolComparator()}; - *

- */ - public TaskInstanceComparator getTaskComparator() { - return comparator; - } + if (this.consideredEquality == TaskEquality.IDENTICAL) { + comparator = new TaskIdentityComparator(); + } else { + comparator = new TaskInstanceComparator(this.consideredEquality); + } + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolStrategy#createSymbolMap() - */ - @Override - public SymbolMap createSymbolMap() { - if (consideredEquality == TaskEquality.IDENTICAL) { - return new TaskSymbolIdentityMap(); - } - else { - return new TaskSymbolBucketedMap(comparator); - } - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.usageprofiles.SymbolStrategy#copySymbolMap(SymbolMap + * ) + */ + @Override + public SymbolMap copySymbolMap( + SymbolMap other) { + if (consideredEquality == TaskEquality.IDENTICAL) { + return new TaskSymbolIdentityMap(other); + } else { + return new TaskSymbolBucketedMap(comparator); + } + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolStrategy#copySymbolMap(SymbolMap) - */ - @Override - public SymbolMap copySymbolMap(SymbolMap other) { - if (consideredEquality == TaskEquality.IDENTICAL) { - return new TaskSymbolIdentityMap(other); - } - else { - return new TaskSymbolBucketedMap(comparator); - } - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usageprofiles.SymbolStrategy#createSymbolMap() + */ + @Override + public SymbolMap createSymbolMap() { + if (consideredEquality == TaskEquality.IDENTICAL) { + return new TaskSymbolIdentityMap(); + } else { + return new TaskSymbolBucketedMap(comparator); + } + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.usageprofiles.SymbolStrategy#getSymbolComparator() + */ + @Override + public SymbolComparator getSymbolComparator() { + return comparator; + } + + /** + *

+ * convenience method to have a correctly typed return value as alternative + * to {@link #getSymbolComparator()}; + *

+ */ + public TaskInstanceComparator getTaskComparator() { + return comparator; + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskIdentityComparator.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskIdentityComparator.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskIdentityComparator.java (revision 1733) @@ -20,29 +20,34 @@ /** *

- * symbol comparator implementation for task instances considering to task instances as equal if - * they refer to the identical task object (comparison of object references). + * symbol comparator implementation for task instances considering to task + * instances as equal if they refer to the identical task object (comparison of + * object references). *

*/ class TaskIdentityComparator extends TaskInstanceComparator { - /** */ - private static final long serialVersionUID = 1L; - - /** - *

- * initializes the parent class with the task equality {@link TaskEquality#IDENTICAL}. - *

- */ - public TaskIdentityComparator() { - super(TaskEquality.IDENTICAL); - } - - /* (non-Javadoc) - * @see SymbolComparator#equals(Object, Object) - */ - @Override - public boolean equals(ITaskInstance taskInstance1, ITaskInstance taskInstance2) { - return taskInstance1.getTask() == taskInstance2.getTask(); - } + /** */ + private static final long serialVersionUID = 1L; + + /** + *

+ * initializes the parent class with the task equality + * {@link TaskEquality#IDENTICAL}. + *

+ */ + public TaskIdentityComparator() { + super(TaskEquality.IDENTICAL); + } + + /* + * (non-Javadoc) + * + * @see SymbolComparator#equals(Object, Object) + */ + @Override + public boolean equals(ITaskInstance taskInstance1, + ITaskInstance taskInstance2) { + return taskInstance1.getTask() == taskInstance2.getTask(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskInstanceComparator.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskInstanceComparator.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskInstanceComparator.java (revision 1733) @@ -27,287 +27,313 @@ /** *

- * implementation of a symbol comparator for task instances. Internally, it uses comparison buffers - * to prevent comparing two tasks or task instances several times. It internally instantiates - * comparers being the implementation strategy of the comparisons required for a specific level - * of task equality. The comparers internally use the {@link TaskEqualityRuleManager} for - * performing comparisons. + * implementation of a symbol comparator for task instances. Internally, it uses + * comparison buffers to prevent comparing two tasks or task instances several + * times. It internally instantiates comparers being the implementation strategy + * of the comparisons required for a specific level of task equality. The + * comparers internally use the {@link TaskEqualityRuleManager} for performing + * comparisons. *

*/ public class TaskInstanceComparator implements SymbolComparator { - - /** */ - private static final long serialVersionUID = 1L; - - /** - * the maximum size of the internal buffer used for storing comparison results - */ - private static final int MAX_BUFFER_SIZE = 2 * 1024 * 1024; - - /** - * the considered level of task equality - */ - private TaskEquality minimalTaskEquality; - - /** - * the comparer used internally for comparing two tasks - */ - private transient Comparer comparer; - - /** - * the comparer used for comparing two tasks on the lexical level - */ - private transient Comparer lexicalComparer; - - /** - * internal buffer used for storing comparison results - */ - private transient HashMap equalityBuffer = new HashMap(); - - /** - * internal buffer used for storing comparison results only for lexical comparisons - */ - private transient HashMap lexicalEqualityBuffer; - - /** - *

- * initializes the comparator with a considered task equality level - *

- * - * @param minimalTaskEquality the considered task equality level - */ - public TaskInstanceComparator(TaskEquality minimalTaskEquality) { - this.minimalTaskEquality = minimalTaskEquality; - init(); - } - - /* (non-Javadoc) - * @see SymbolComparator#equals(Object, Object) - */ - @Override - public boolean equals(ITaskInstance taskInstance1, ITaskInstance taskInstance2) { - return equals(taskInstance1.getTask(), taskInstance2.getTask()); - } - - /** - *

- * returns true, if this comparator considers the provided tasks as equal, false else - *

- * - * @param task1 the first task to compare - * @param task2 the second task to compare - * - * @return as described - */ - public boolean equals(ITask task1, ITask task2) { - Boolean result; - - if (task1 != task2) { - //if ((task1 instanceof IEventTask) && (task2 instanceof IEventTask)) { - long key = ((long) System.identityHashCode(task1)) << 32; - key += System.identityHashCode(task2); - - result = equalityBuffer.get(key); - - if (result == null) { - result = comparer.compare(task1, task2); - - if (equalityBuffer.size() < MAX_BUFFER_SIZE) { - equalityBuffer.put(key, result); - } - } - /*} - else { - result = false; - }*/ - } - else { - result = true; - } - - return result; - } - - /** - *

- * returns true, if this comparator considers the provided tasks as lexically equal, false else - *

- * - * @param task1 the first task to compare - * @param task2 the second task to compare - * - * @return as described - */ - public boolean areLexicallyEqual(ITask task1, ITask task2) { - Boolean result; - - if (task1 != task2) { - long key = ((long) System.identityHashCode(task1)) << 32; - key += System.identityHashCode(task2); - - result = lexicalEqualityBuffer.get(key); - - if (result == null) { - result = lexicalComparer.compare(task1, task2); - if (equalityBuffer.size() < MAX_BUFFER_SIZE) { - lexicalEqualityBuffer.put(key, result); - } - } - } - else { - result = true; - } - - return result; - } - - /** - *

- * can be called externally to clear the internal comparison buffers - *

- */ - public void clearBuffers() { - equalityBuffer.clear(); - init(); - } - - /** - *

- * initializes the comparator with comparers depending on the different comparison levels as - * well as with the required comparison buffers. Comparers and buffers for lexical comparison - * may be reused if the considered equality level is also lexical. - *

- */ - private void init() { - if (minimalTaskEquality == TaskEquality.LEXICALLY_EQUAL) { - comparer = new LexicalComparer(); - } - else if (minimalTaskEquality == TaskEquality.SYNTACTICALLY_EQUAL) { - comparer = new SyntacticalComparer(); - } - else if (minimalTaskEquality == TaskEquality.SEMANTICALLY_EQUAL) { - comparer = new SemanticalComparer(); - } - else { - comparer = new DefaultComparer(this.minimalTaskEquality); - } - - if (minimalTaskEquality == TaskEquality.LEXICALLY_EQUAL) { - lexicalComparer = comparer; - lexicalEqualityBuffer = equalityBuffer; - } - else { - lexicalComparer = new LexicalComparer(); - lexicalEqualityBuffer = new HashMap(); - } - } - - /** - *

- * deserialize this object and reinitialize the buffers - *

- */ - private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { - in.defaultReadObject(); - init(); - } - - - /** - *

- * interface for internally used comparers containing only a compare method - *

- */ - private static interface Comparer { - - /** - *

- * returns true, if this comparator considers the provided tasks as equal, false else - *

- * - * @param task1 the first task to compare - * @param task2 the second task to compare - * - * @return as described - */ - boolean compare(ITask task1, ITask task2); - } - - /** - *

- * comparer that performs comparisons only on the lexical level - *

- */ - private static class LexicalComparer implements Comparer { - - /* (non-Javadoc) - * @see Comparer#compare(ITask, ITask) - */ - public boolean compare(ITask task1, ITask task2) { - return TaskEqualityRuleManager.getInstance().areLexicallyEqual(task1, task2); - } - } - - /** - *

- * comparer that performs comparisons only on the syntactical level - *

- * - */ - private static class SyntacticalComparer implements Comparer { - - /* (non-Javadoc) - * @see Comparer#compare(ITask, ITask) - */ - public boolean compare(ITask task1, ITask task2) { - return TaskEqualityRuleManager.getInstance().areSyntacticallyEqual(task1, task2); - } - } - - /** - *

- * comparer that performs comparisons only on the semantical level - *

- */ - private static class SemanticalComparer implements Comparer { - - /* (non-Javadoc) - * @see Comparer#compare(ITask, ITask) - */ - public boolean compare(ITask task1, ITask task2) { - return TaskEqualityRuleManager.getInstance().areSemanticallyEqual(task1, task2); - } - } - - /** - *

- * comparer that performs comparisons only on the provided level - *

- */ - private static class DefaultComparer implements Comparer { - - /** - *

- * the minimal task equality considered by this comparer - *

- */ - private TaskEquality minimalTaskEquality; - - /** - *

- * initializes this comparer with the task equality to be considered - *

- */ - public DefaultComparer(TaskEquality minimalTaskEquality) { - this.minimalTaskEquality = minimalTaskEquality; - } - - /* (non-Javadoc) - * @see Comparer#compare(ITask, ITask) - */ - public boolean compare(ITask task1, ITask task2) { - return TaskEqualityRuleManager.getInstance().areAtLeastEqual - (task1, task2, minimalTaskEquality); - } - } + + /** + *

+ * interface for internally used comparers containing only a compare method + *

+ */ + private static interface Comparer { + + /** + *

+ * returns true, if this comparator considers the provided tasks as + * equal, false else + *

+ * + * @param task1 + * the first task to compare + * @param task2 + * the second task to compare + * + * @return as described + */ + boolean compare(ITask task1, ITask task2); + } + + /** + *

+ * comparer that performs comparisons only on the provided level + *

+ */ + private static class DefaultComparer implements Comparer { + + /** + *

+ * the minimal task equality considered by this comparer + *

+ */ + private final TaskEquality minimalTaskEquality; + + /** + *

+ * initializes this comparer with the task equality to be considered + *

+ */ + public DefaultComparer(TaskEquality minimalTaskEquality) { + this.minimalTaskEquality = minimalTaskEquality; + } + + /* + * (non-Javadoc) + * + * @see Comparer#compare(ITask, ITask) + */ + @Override + public boolean compare(ITask task1, ITask task2) { + return TaskEqualityRuleManager.getInstance().areAtLeastEqual(task1, + task2, minimalTaskEquality); + } + } + + /** + *

+ * comparer that performs comparisons only on the lexical level + *

+ */ + private static class LexicalComparer implements Comparer { + + /* + * (non-Javadoc) + * + * @see Comparer#compare(ITask, ITask) + */ + @Override + public boolean compare(ITask task1, ITask task2) { + return TaskEqualityRuleManager.getInstance().areLexicallyEqual( + task1, task2); + } + } + + /** + *

+ * comparer that performs comparisons only on the semantical level + *

+ */ + private static class SemanticalComparer implements Comparer { + + /* + * (non-Javadoc) + * + * @see Comparer#compare(ITask, ITask) + */ + @Override + public boolean compare(ITask task1, ITask task2) { + return TaskEqualityRuleManager.getInstance().areSemanticallyEqual( + task1, task2); + } + } + + /** + *

+ * comparer that performs comparisons only on the syntactical level + *

+ * + */ + private static class SyntacticalComparer implements Comparer { + + /* + * (non-Javadoc) + * + * @see Comparer#compare(ITask, ITask) + */ + @Override + public boolean compare(ITask task1, ITask task2) { + return TaskEqualityRuleManager.getInstance().areSyntacticallyEqual( + task1, task2); + } + } + + /** */ + private static final long serialVersionUID = 1L; + + /** + * the maximum size of the internal buffer used for storing comparison + * results + */ + private static final int MAX_BUFFER_SIZE = 2 * 1024 * 1024; + + /** + * the considered level of task equality + */ + private final TaskEquality minimalTaskEquality; + + /** + * the comparer used internally for comparing two tasks + */ + private transient Comparer comparer; + + /** + * the comparer used for comparing two tasks on the lexical level + */ + private transient Comparer lexicalComparer; + + /** + * internal buffer used for storing comparison results + */ + private transient HashMap equalityBuffer = new HashMap(); + + /** + * internal buffer used for storing comparison results only for lexical + * comparisons + */ + private transient HashMap lexicalEqualityBuffer; + + /** + *

+ * initializes the comparator with a considered task equality level + *

+ * + * @param minimalTaskEquality + * the considered task equality level + */ + public TaskInstanceComparator(TaskEquality minimalTaskEquality) { + this.minimalTaskEquality = minimalTaskEquality; + init(); + } + + /** + *

+ * returns true, if this comparator considers the provided tasks as + * lexically equal, false else + *

+ * + * @param task1 + * the first task to compare + * @param task2 + * the second task to compare + * + * @return as described + */ + public boolean areLexicallyEqual(ITask task1, ITask task2) { + Boolean result; + + if (task1 != task2) { + long key = ((long) System.identityHashCode(task1)) << 32; + key += System.identityHashCode(task2); + + result = lexicalEqualityBuffer.get(key); + + if (result == null) { + result = lexicalComparer.compare(task1, task2); + if (equalityBuffer.size() < MAX_BUFFER_SIZE) { + lexicalEqualityBuffer.put(key, result); + } + } + } else { + result = true; + } + + return result; + } + + /** + *

+ * can be called externally to clear the internal comparison buffers + *

+ */ + public void clearBuffers() { + equalityBuffer.clear(); + init(); + } + + /** + *

+ * returns true, if this comparator considers the provided tasks as equal, + * false else + *

+ * + * @param task1 + * the first task to compare + * @param task2 + * the second task to compare + * + * @return as described + */ + public boolean equals(ITask task1, ITask task2) { + Boolean result; + + if (task1 != task2) { + // if ((task1 instanceof IEventTask) && (task2 instanceof + // IEventTask)) { + long key = ((long) System.identityHashCode(task1)) << 32; + key += System.identityHashCode(task2); + + result = equalityBuffer.get(key); + + if (result == null) { + result = comparer.compare(task1, task2); + + if (equalityBuffer.size() < MAX_BUFFER_SIZE) { + equalityBuffer.put(key, result); + } + } + /* + * } else { result = false; } + */ + } else { + result = true; + } + + return result; + } + + /* + * (non-Javadoc) + * + * @see SymbolComparator#equals(Object, Object) + */ + @Override + public boolean equals(ITaskInstance taskInstance1, + ITaskInstance taskInstance2) { + return equals(taskInstance1.getTask(), taskInstance2.getTask()); + } + + /** + *

+ * initializes the comparator with comparers depending on the different + * comparison levels as well as with the required comparison buffers. + * Comparers and buffers for lexical comparison may be reused if the + * considered equality level is also lexical. + *

+ */ + private void init() { + if (minimalTaskEquality == TaskEquality.LEXICALLY_EQUAL) { + comparer = new LexicalComparer(); + } else if (minimalTaskEquality == TaskEquality.SYNTACTICALLY_EQUAL) { + comparer = new SyntacticalComparer(); + } else if (minimalTaskEquality == TaskEquality.SEMANTICALLY_EQUAL) { + comparer = new SemanticalComparer(); + } else { + comparer = new DefaultComparer(this.minimalTaskEquality); + } + + if (minimalTaskEquality == TaskEquality.LEXICALLY_EQUAL) { + lexicalComparer = comparer; + lexicalEqualityBuffer = equalityBuffer; + } else { + lexicalComparer = new LexicalComparer(); + lexicalEqualityBuffer = new HashMap(); + } + } + + /** + *

+ * deserialize this object and reinitialize the buffers + *

+ */ + private void readObject(ObjectInputStream in) throws IOException, + ClassNotFoundException { + in.defaultReadObject(); + init(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskInstanceTrie.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskInstanceTrie.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskInstanceTrie.java (revision 1733) @@ -29,10 +29,11 @@ /** *

- * This trie implementation is a performance optimization for generating task trees. It does not - * create a full trie but adds only those subsequences having a chance of occurring most often. - * For this, it initially counts the number of occurrences of each task instance. Then, during - * training, it regularly determines the number of the currently most often occurring sequence. If - * this number is higher than the count of a task instance to be trained, the task instance is - * skipped the not added to the trie. + * This trie implementation is a performance optimization for generating task + * trees. It does not create a full trie but adds only those subsequences having + * a chance of occurring most often. For this, it initially counts the number of + * occurrences of each task instance. Then, during training, it regularly + * determines the number of the currently most often occurring sequence. If this + * number is higher than the count of a task instance to be trained, the task + * instance is skipped the not added to the trie. *

* @@ -41,220 +42,238 @@ class TaskInstanceTrie extends Trie { - /** */ - private static final long serialVersionUID = 1L; - - /** - *

- * the task handling strategy to be used for comparing tasks - *

- */ - private TaskHandlingStrategy taskStrategy; - - /** - *

- * instantiated the trie with the task handling strategy to be used - *

- * - * @param taskStrategy the task handling strategy to be used for comparing tasks - */ - public TaskInstanceTrie(TaskHandlingStrategy taskStrategy) { - super(taskStrategy); - this.taskStrategy = taskStrategy; - } - - /** - *

- * trains this trie with the provided user sessions up to the provided maximum depth using - * the optimization described in the description of this class. - *

- * - * @param userSessions the sessions for which this trie is to be trained - * @param maxOrder the depth of the trie - */ - public void trainSessions(List userSessions, int maxOrder) { - if (maxOrder < 1) { - return; - } - - SymbolMap equalTaskInstancesMap = - taskStrategy.createSymbolMap(); - - Map instanceCountMap = new HashMap(); - - System.out.println("preparing training"); - int noOfTaskInstances = 0; - for (IUserSession session : userSessions) { - for (ITaskInstance taskInstance : session) { - Counter counter = equalTaskInstancesMap.getValue(taskInstance); - - if (counter == null) { - counter = new Counter(); - equalTaskInstancesMap.addSymbol(taskInstance, counter); - } - - counter.count++; - instanceCountMap.put(taskInstance.getTask(), counter); - - noOfTaskInstances++; - } - } - - System.out.println("performing training of " + noOfTaskInstances + " task instances"); - Counter processedTaskInstances = new Counter(); - int counterRecheckAt = noOfTaskInstances / 10; // recheck the maximum count after each - // 10% of processed task instances - for (IUserSession session : userSessions) { - train(session, maxOrder, instanceCountMap, processedTaskInstances, counterRecheckAt); - } - - updateKnownSymbols(); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.Trie#equals(java.lang.Object) - */ - @Override - public boolean equals(Object other) { - if (this == other) { - return true; - } - else if (other instanceof TaskInstanceTrie) { - return super.equals(other); - } - else { - return false; - } - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.Trie#hashCode() - */ - @Override - public int hashCode() { - return super.hashCode(); - } - - /** - *

- * internally used convenience method for implementing the training optimization - *

- */ - private void train(IUserSession userSession, - int maxOrder, - Map taskInstanceCountMap, - Counter processedTaskInstances, - int counterRecheckAt) - { - List subsequence = new LinkedList(); - - int sequenceMaxCount = 0; - - for (ITaskInstance currentTaskInstance : userSession) { - - int occurrenceCount = taskInstanceCountMap.get(currentTaskInstance.getTask()).count; - - if (processedTaskInstances.count >= counterRecheckAt) { - sequenceMaxCount = getCurrentSequenceMaxCount(); - processedTaskInstances.count = 0; - } - - if (occurrenceCount < sequenceMaxCount) { - // this task instance does not need to be considered, as it occurs not often enough - // to be part of a sequence, that occurs most often. Therefore train all remaining - // sequences so far and go on, until the next useful sequence is found. - - while (subsequence.size() > 1) { - add(subsequence); - subsequence.remove(0); - } - - subsequence.clear(); - } - else { - subsequence.add(currentTaskInstance); - - if (subsequence.size() == maxOrder) { - add(subsequence); - subsequence.remove(0); - } - } - - processedTaskInstances.count++; - } - - // add shorter remaining subsequences, if any - while (subsequence.size() > 1) { - add(subsequence); - subsequence.remove(0); - } - } - - /** - *

- * determines the current maximum count of sequences of a minimal length of two. Task instances - * occuring more seldom do not have to be considered anymore - *

- * - * @return the current maximum count of sequences of a minimal length of two - */ - private int getCurrentSequenceMaxCount() { - MaxSequenceCountFinder processor = new MaxSequenceCountFinder(); - super.process(processor); - return processor.getMaxCount(); - } - - /** - *

- * trie processor identifying the current maximum count of sequences of a minimal length of two - *

- * - * @author Patrick Harms - */ - private static class MaxSequenceCountFinder implements TrieProcessor { - - /** - *

- * the current maximum count - *

- */ - private int currentCount = 0; - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.TrieProcessor#process(java.util.List, int) - */ - @Override - public TrieProcessor.Result process(List foundTask, int count) { - if (foundTask.size() == 2) { - this.currentCount = Math.max(this.currentCount, count); - - // do not consider children - return TrieProcessor.Result.SKIP_NODE; - } - else { - return TrieProcessor.Result.CONTINUE; - } - } - - /** - *

- * returns the current maximum count - *

- */ - private int getMaxCount() { - return currentCount; - } - - } - - /** - *

- * counter object to be able to call something by the counters reference - *

- * - * @author Patrick Harms - */ - private static class Counter { - int count = 0; - } - + /** + *

+ * counter object to be able to call something by the counters reference + *

+ * + * @author Patrick Harms + */ + private static class Counter { + int count = 0; + } + + /** + *

+ * trie processor identifying the current maximum count of sequences of a + * minimal length of two + *

+ * + * @author Patrick Harms + */ + private static class MaxSequenceCountFinder implements + TrieProcessor { + + /** + *

+ * the current maximum count + *

+ */ + private int currentCount = 0; + + /** + *

+ * returns the current maximum count + *

+ */ + private int getMaxCount() { + return currentCount; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.usageprofiles.TrieProcessor#process(java.util + * .List, int) + */ + @Override + public TrieProcessor.Result process(List foundTask, + int count) { + if (foundTask.size() == 2) { + this.currentCount = Math.max(this.currentCount, count); + + // do not consider children + return TrieProcessor.Result.SKIP_NODE; + } else { + return TrieProcessor.Result.CONTINUE; + } + } + + } + + /** */ + private static final long serialVersionUID = 1L; + + /** + *

+ * the task handling strategy to be used for comparing tasks + *

+ */ + private final TaskHandlingStrategy taskStrategy; + + /** + *

+ * instantiated the trie with the task handling strategy to be used + *

+ * + * @param taskStrategy + * the task handling strategy to be used for comparing tasks + */ + public TaskInstanceTrie(TaskHandlingStrategy taskStrategy) { + super(taskStrategy); + this.taskStrategy = taskStrategy; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usageprofiles.Trie#equals(java.lang.Object) + */ + @Override + public boolean equals(Object other) { + if (this == other) { + return true; + } else if (other instanceof TaskInstanceTrie) { + return super.equals(other); + } else { + return false; + } + } + + /** + *

+ * determines the current maximum count of sequences of a minimal length of + * two. Task instances occuring more seldom do not have to be considered + * anymore + *

+ * + * @return the current maximum count of sequences of a minimal length of two + */ + private int getCurrentSequenceMaxCount() { + final MaxSequenceCountFinder processor = new MaxSequenceCountFinder(); + super.process(processor); + return processor.getMaxCount(); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usageprofiles.Trie#hashCode() + */ + @Override + public int hashCode() { + return super.hashCode(); + } + + /** + *

+ * internally used convenience method for implementing the training + * optimization + *

+ */ + private void train(IUserSession userSession, int maxOrder, + Map taskInstanceCountMap, + Counter processedTaskInstances, int counterRecheckAt) { + final List subsequence = new LinkedList(); + + int sequenceMaxCount = 0; + + for (final ITaskInstance currentTaskInstance : userSession) { + + final int occurrenceCount = taskInstanceCountMap + .get(currentTaskInstance.getTask()).count; + + if (processedTaskInstances.count >= counterRecheckAt) { + sequenceMaxCount = getCurrentSequenceMaxCount(); + processedTaskInstances.count = 0; + } + + if (occurrenceCount < sequenceMaxCount) { + // this task instance does not need to be considered, as it + // occurs not often enough + // to be part of a sequence, that occurs most often. Therefore + // train all remaining + // sequences so far and go on, until the next useful sequence is + // found. + + while (subsequence.size() > 1) { + add(subsequence); + subsequence.remove(0); + } + + subsequence.clear(); + } else { + subsequence.add(currentTaskInstance); + + if (subsequence.size() == maxOrder) { + add(subsequence); + subsequence.remove(0); + } + } + + processedTaskInstances.count++; + } + + // add shorter remaining subsequences, if any + while (subsequence.size() > 1) { + add(subsequence); + subsequence.remove(0); + } + } + + /** + *

+ * trains this trie with the provided user sessions up to the provided + * maximum depth using the optimization described in the description of this + * class. + *

+ * + * @param userSessions + * the sessions for which this trie is to be trained + * @param maxOrder + * the depth of the trie + */ + public void trainSessions(List userSessions, int maxOrder) { + if (maxOrder < 1) { + return; + } + + final SymbolMap equalTaskInstancesMap = taskStrategy + .createSymbolMap(); + + final Map instanceCountMap = new HashMap(); + + System.out.println("preparing training"); + int noOfTaskInstances = 0; + for (final IUserSession session : userSessions) { + for (final ITaskInstance taskInstance : session) { + Counter counter = equalTaskInstancesMap.getValue(taskInstance); + + if (counter == null) { + counter = new Counter(); + equalTaskInstancesMap.addSymbol(taskInstance, counter); + } + + counter.count++; + instanceCountMap.put(taskInstance.getTask(), counter); + + noOfTaskInstances++; + } + } + + System.out.println("performing training of " + noOfTaskInstances + + " task instances"); + final Counter processedTaskInstances = new Counter(); + final int counterRecheckAt = noOfTaskInstances / 10; // recheck the + // maximum count + // after each + // 10% of processed task instances + for (final IUserSession session : userSessions) { + train(session, maxOrder, instanceCountMap, processedTaskInstances, + counterRecheckAt); + } + + updateKnownSymbols(); + } + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskSymbolBucketedMap.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskSymbolBucketedMap.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskSymbolBucketedMap.java (revision 1733) @@ -36,17 +36,20 @@ /** *

- * This class is a data structure for holding task instances in form of a symbol map. It is more - * efficient than a simple list. This data structure can be used with a comparator to adapt the - * effective list behavior and to define the equals strategy for comparing task instances. After a - * certain size ({@link #MAX_LIST_SIZE}), the map creates an index consisting of buckets of similar - * task instances. This allows searching for task instances in a more efficient order as the search - * can start in the most appropriate of the internal buckets. + * This class is a data structure for holding task instances in form of a symbol + * map. It is more efficient than a simple list. This data structure can be used + * with a comparator to adapt the effective list behavior and to define the + * equals strategy for comparing task instances. After a certain size ( + * {@link #MAX_LIST_SIZE}), the map creates an index consisting of buckets of + * similar task instances. This allows searching for task instances in a more + * efficient order as the search can start in the most appropriate of the + * internal buckets. *

*

- * The class is called a map, although it is not. It may contain the same task instances as - * separate keys. This implementation is done for performance improvements. If it is required to - * really assure, that a key exists only once, then each call to the - * {@link #addSymbol(Object, Object)} method should be done only, if the - * {@link #containsSymbol(Object)} method for the same symbol returns false. + * The class is called a map, although it is not. It may contain the same task + * instances as separate keys. This implementation is done for performance + * improvements. If it is required to really assure, that a key exists only + * once, then each call to the {@link #addSymbol(Object, Object)} method should + * be done only, if the {@link #containsSymbol(Object)} method for the same + * symbol returns false. *

* @@ -56,865 +59,967 @@ * @param */ -class TaskSymbolBucketedMap implements SymbolMap, Serializable { - - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; - - /** - *

- * the maximum number of task instances in this map which is still only treated as list - * instead of using buckets. - *

- */ - private static final int MAX_LIST_SIZE = 15; - - /** - *

- * Comparator to be used for comparing the task instances with each other - *

- */ - private TaskInstanceComparator comparator; - - /** - *

- * Internally maintained plain list of task instances and associated values - *

- */ - private List> symbolList; - - /** - *

- * If the size of the map exceeds {@link #MAX_LIST_SIZE}, this is the index using buckets - * for optimizing the search order. - *

- */ - private Map>> symbolBuckets; - - /** - *

- * When using buckets, not any task instance may be associated a correct bucket. Therefore, we - * set a default bucket for all such task instances. This may change if the same bucket for a - * specific symbol is selected. - *

- */ - private int defaultBucket = 0; - - /** - *

- * Instantiates a task instance map with a comparator - *

- * - * @param comparator the comparator to use for comparing task instances - * - * @throws IllegalArgumentException if the provided comparator is null - */ - public TaskSymbolBucketedMap(TaskInstanceComparator comparator) { - if (comparator == null) { - throw new IllegalArgumentException("comparator must not be null"); - } - - this.comparator = comparator; - this.symbolList = new ArrayList>(); - } - - /** - *

- * Copy constructor - *

- * - * @param otherMap the other map to be copied including its comparator - * - * @throws IllegalArgumentException if the provided other map is null - */ - public TaskSymbolBucketedMap(TaskSymbolBucketedMap otherMap) { - if (otherMap == null) { - throw new IllegalArgumentException("otherMap must not be null"); - } - - this.comparator = otherMap.comparator; - this.symbolList = new ArrayList>(otherMap.symbolList); - - if (this.symbolList.size() > MAX_LIST_SIZE) { - createSymbolBuckets(); - } - } - - /** - *

- * Returns the size of the map, i.e. the number of task instance entries - *

- * - * @return as described - */ - public int size() { - return symbolList.size(); - } - - /** - *

- * Returns true if this map is empty, i.e. if {@link #size()} returns 0 - *

- * - * @return as described - */ - public boolean isEmpty() { - return symbolList.isEmpty(); - } - - /** - *

- * Returns true if the provided task instance was stored in this map. - *

- * - * @param symbol the task instance to check if it was stored in this map - * - * @return as described - * - * @throws IllegalArgumentException if the provided task instance is null - */ - public boolean containsSymbol(ITaskInstance symbol) { - if (symbol == null) { - throw new IllegalArgumentException("symbol must not be null"); - } - - return getEntry(symbol) != null; - } - - /** - *

- * Returns the value associated to the provided task instance in this map. If there is no value - * associated to the given task instance or if the task instance is not stored in this map, - * the method returns null. - *

- * - * @param symbol the task instance to return the value for - * - * @return as described - * - * @throws IllegalArgumentException if the provided task instance is null - */ - public V getValue(ITaskInstance symbol) { - if (symbol == null) { - throw new IllegalArgumentException("symbol must not be null"); - } - - Map.Entry entry = getEntry(symbol); - - if (entry != null) { - return entry.getValue(); - } - else { - return null; - } - } - - /** - *

- * Adds a task instance and an associated value to the map. If the value is null, the task - * instance is added, anyway and {@link #containsSymbol(Object)} will return true for that - * task instance. Adding the same task instance twice will produce two entries. This is - * contradictory to typical map implementations. To prevent this, the - * {@link #containsSymbol(Object)} and {@link #removeSymbol(Object)} methods should be used to - * ensure map behavior. - *

- * - * @param symbol the task instance to add to the map - * @param value the value to associate to the task instance in this map - * - * @return as described - * - * @throws IllegalArgumentException if the provided task instance is null - */ - public void addSymbol(ITaskInstance symbol, V value) { - if (symbol == null) { - throw new IllegalArgumentException("symbol must not be null"); - } - - Map.Entry entry = new SymbolMapEntry(symbol, value); - - symbolList.add(entry); - - if (symbolList.size() > MAX_LIST_SIZE) { - if (symbolBuckets == null) { - createSymbolBuckets(); - } - else { - addToSymbolBucket(entry); - } - } - } - - /** - *

- * Removes a task instance and its associated value from the map. If the task instance is - * stored several times, only the first of its occurrences is removed. - *

- * - * @param symbol the task instance to be removed from the map - * - * @return as described - * - * @throws IllegalArgumentException if the provided task instance is null - */ - public V removeSymbol(ITaskInstance symbol) { - if (symbol == null) { - throw new IllegalArgumentException("symbol must not be null"); - } - - for (int i = 0; i < symbolList.size(); i++) { - if (comparator.equals(symbolList.get(i).getKey(), symbol)) { - // found the symbol. Remove it from the list, and if required, also from the map. - V value = symbolList.remove(i).getValue(); - - if (symbolList.size() > MAX_LIST_SIZE) { - removeFromSymbolBuckets(symbol); - } - - return value; - } - } - - return null; - } - - /** - *

- * Returns a collection of all task instances in this map. - *

- * - * @return as described - */ - public Collection getSymbols() { - return new ReadOnlyCollectionFacade(symbolList, new SymbolFacade()); - } - - /** - *

- * Returns a collection of all values associated to task instances in this map. May contain - * null values, if some of the task instances are mapped to null. The length of the returned - * collection is in any case the same as the size of the map. - *

- * - * @return as described - */ - public Collection getValues() { - return new ReadOnlyCollectionFacade(symbolList, new ValueFacade()); - } - - /** - *

- * Removes all task instances and associated values from the map. - *

- */ - public void clear() { - symbolList.clear(); - symbolBuckets = null; - } - - /* (non-Javadoc) - * @see java.lang.Object#hashCode() - */ - @Override - public int hashCode() { - return symbolList.size(); - } - - /* (non-Javadoc) - * @see java.lang.Object#equals(java.lang.Object) - */ - @SuppressWarnings("unchecked") - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - else if (this.getClass().isInstance(obj)) { - TaskSymbolBucketedMap other = (TaskSymbolBucketedMap) obj; - - return (symbolList.size() == other.symbolList.size()) && - (symbolList.containsAll(other.symbolList)); - } - else { - return false; - } - } - - /** - *

- * Internally used to create task instance buckets in case the number of stored task instances - * increased above {@link #MAX_LIST_SIZE}. - *

- */ - private void createSymbolBuckets() { - //System.out.println("creating symbol buckets"); - symbolBuckets = new HashMap>>(); - - for (Map.Entry symbol : symbolList) { - addToSymbolBucket(symbol); - } - } - - /** - *

- * Adds a task instance and its value to its corresponding bucket. The corresponding bucket is - * the first element of the array returned by the method - * {@link #getBucketSearchOrder(ITaskInstance)}. If no search order for a task instance is - * defined, the entry is added to the default bucket. If the bucket id identical to the default - * bucket id, the default bucket id is shifted to another value. - *

- */ - private void addToSymbolBucket(Map.Entry symbolEntry) { - int bucketId = defaultBucket; - int[] bucketSearchOrder = getBucketSearchOrder(symbolEntry.getKey()); - - if ((bucketSearchOrder != null) && (bucketSearchOrder.length > 0)) { - bucketId = bucketSearchOrder[0]; - - if (bucketId == defaultBucket) { - setNewDefaultBucketId(); - } - } - - List> list = symbolBuckets.get(bucketId); - - if (list == null) { - list = new LinkedList>(); - symbolBuckets.put(bucketId, list); - } - - list.add(symbolEntry); - } - - /** - *

- * returns the search order for a task instance which is different for event task instances, - * sequence instances, selection instances, and iteration instances - *

- */ - private int[] getBucketSearchOrder(ITaskInstance taskInstance) { - // 0 = sequence; 1 = selection; 2 = iteration; 3 = optional; 4 = event task in general; - // other = hashCode of name of event type - - if (taskInstance instanceof IEventTaskInstance) { - // event tasks are most likely equal to those of the same type happening on the same - // target. Afterwards, they should be equal to those of the event type with the same - // name. Afterwards, they may be equal to iterations, optionals, other event tasks, - // selections, and finally the rest. - Event event = ((IEventTaskInstance) taskInstance).getEvent(); - return new int[] { event.getTarget().hashCode() + event.getType().getName().hashCode(), - event.getType().getName().hashCode(), 2, 3, 4, 1 }; - } - else if (taskInstance instanceof ISequenceInstance) { - return new int[] { 0, 2, 3, 1 }; - } - else if (taskInstance instanceof ISelectionInstance) { - return new int[] { 1, 4, 2, 3 }; - } - else if (taskInstance instanceof IIterationInstance) { - return new int[] { 2, 1, 4 }; - } - - return null; - } - - /** - *

- * Removes the entry for a given task instance from the buckets. It uses the bucket search order - * defined to find the task instance as fast as possible. - *

- */ - private Map.Entry removeFromSymbolBuckets(ITaskInstance symbol) { - int bucketId = defaultBucket; - int[] bucketSearchOrder = getBucketSearchOrder(symbol); - - if ((bucketSearchOrder != null) && (bucketSearchOrder.length > 0)) { - bucketId = bucketSearchOrder[0]; - } - - List> list = symbolBuckets.get(bucketId); - Map.Entry result = null; - - if (list != null) { - for (int i = 0; i < list.size(); i++) { - if (comparator.equals(list.get(i).getKey(), symbol)) { - result = list.remove(i); - break; - } - } - - if (list.isEmpty()) { - symbolBuckets.remove(bucketId); - } - } - - return result; - } - - /** - *

- * Updates the default bucket id to a new one - *

- */ - private void setNewDefaultBucketId() { - int oldDefaultBucket = defaultBucket; - do { - defaultBucket += 1; - } - while (symbolBuckets.containsKey(defaultBucket)); - - symbolBuckets.put(defaultBucket, symbolBuckets.remove(oldDefaultBucket)); - } - - /** - *

- * searches for the entry belonging to the given task instance. The method either uses the - * list if buckets are not used yet, or it uses the buckets and searches them in the order - * defined by the method {@link #getBucketSearchOrder(ITaskInstance)}. If the task instances - * isn't found and the bucket search order does not refer all buckets, then also the other - * buckets are searched for the task instance. - *

- */ - private Map.Entry getEntry(ITaskInstance symbol) { - Map.Entry entry = null; - if (symbolBuckets == null) { - entry = lookup(symbol, symbolList); - } - else { - int[] bucketSearchOrder = getBucketSearchOrder(symbol); - for (int bucketId : bucketSearchOrder) { - List> list = symbolBuckets.get(bucketId); - if (list != null) { - entry = lookup(symbol, list); - if (entry != null) { - break; - } - } - } - - // try to search the other buckets - if (entry == null) { - Arrays.sort(bucketSearchOrder); - for (Map.Entry>> bucket : symbolBuckets.entrySet()) { - if (Arrays.binarySearch(bucketSearchOrder, bucket.getKey()) < 0) { - List> list = bucket.getValue(); - if (list != null) { - entry = lookup(symbol, list); - if (entry != null) { - break; - } - } - } - } - } - } - - return entry; - } - - /** - *

- * Convenience method to look up a symbol in a list of entries using the comparator. - *

- */ - private Map.Entry lookup(ITaskInstance symbol, List> list) { - for (Map.Entry candidate : list) { - if (comparator.equals(candidate.getKey(), symbol)) { - return candidate; - } - } - - return null; - } - - /** - *

- * Internally used data structure for storing task instance - value pairs - *

- * - * @author Patrick Harms - */ - private class SymbolMapEntry implements Map.Entry { - - /** - * the task instance to map to a value - */ - private ITaskInstance symbol; - - /** - * the value associated with the symbol - */ - private V value; - - /** - *

- * Simple constructor for initializing the entry with a task instance and its associated - * value. - *

- */ - private SymbolMapEntry(ITaskInstance symbol, V value) { - super(); - this.symbol = symbol; - this.value = value; - } - - /* (non-Javadoc) - * @see java.util.Map.Entry#getKey() - */ - @Override - public ITaskInstance getKey() { - return symbol; - } - - /* (non-Javadoc) - * @see java.util.Map.Entry#getValue() - */ - @Override - public V getValue() { - return value; - } - - /* (non-Javadoc) - * @see java.util.Map.Entry#setValue(java.lang.Object) - */ - @Override - public V setValue(V value) { - V oldValue = this.value; - this.value = value; - return oldValue; - } - - /* (non-Javadoc) - * @see java.lang.Object#hashCode() - */ - @Override - public int hashCode() { - return symbol.hashCode(); - } - - /* (non-Javadoc) - * @see java.lang.Object#equals(java.lang.Object) - */ - @SuppressWarnings("unchecked") - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - else if (this.getClass().isInstance(obj)) { - SymbolMapEntry other = (SymbolMapEntry) obj; - return (symbol.equals(other.symbol) && - (value == null ? other.value == null : value.equals(other.value))); - } - else { - return false; - } - } - - /* (non-Javadoc) - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - return symbol + "=" + value; - } - - } - - /** - *

- * Used to create an efficient facade for accessing the internal list of entries either only - * for the task instances or only for the values. It is a default implementation of the - * collection interface. The entry facade provided to the constructor decides, if either the - * list accesses only the task instances or only the values. - *

- * - * @author Patrick Harms - */ - private class ReadOnlyCollectionFacade implements Collection { - - /** - * the list facaded by this facade - */ - private List> list; - - /** - * the facade to be used for the entries - */ - private EntryFacade entryFacade; - - /** - *

- * Initializes the facade with the facaded list and the facade to be used for the entries - *

- */ - private ReadOnlyCollectionFacade(List> list, - EntryFacade entryFacade) - { - this.list = list; - this.entryFacade = entryFacade; - } - - /* (non-Javadoc) - * @see java.util.Collection#size() - */ - @Override - public int size() { - return list.size(); - } - - /* (non-Javadoc) - * @see java.util.Collection#isEmpty() - */ - @Override - public boolean isEmpty() { - return list.isEmpty(); - } - - /* (non-Javadoc) - * @see java.util.Collection#contains(java.lang.Object) - */ - @Override - public boolean contains(Object o) { - if (o == null) { - for (Map.Entry entry : list) { - if (entryFacade.getFacadedElement(entry) == null) { - return true; - } - } - } - else { - for (Map.Entry entry : list) { - if (o.equals(entryFacade.getFacadedElement(entry))) { - return true; - } - } - } - - return false; - } - - /* (non-Javadoc) - * @see java.util.Collection#toArray() - */ - @Override - public Object[] toArray() { - Object[] result = new Object[list.size()]; - - for (int i = 0; i < list.size(); i++) { - result[i] = entryFacade.getFacadedElement(list.get(i)); - } - - return result; - } - - /* (non-Javadoc) - * @see java.util.Collection#toArray(T[]) - */ - @SuppressWarnings("unchecked") - @Override - public T[] toArray(T[] a) { - T[] result = a; - - for (int i = 0; i < list.size(); i++) { - result[i] = (T) entryFacade.getFacadedElement(list.get(i)); - } - - return result; - } - - /* (non-Javadoc) - * @see java.util.Collection#add(java.lang.Object) - */ - @Override - public boolean add(TYPE e) { - throw new UnsupportedOperationException("this collection is read only"); - } - - /* (non-Javadoc) - * @see java.util.Collection#remove(java.lang.Object) - */ - @Override - public boolean remove(Object o) { - throw new UnsupportedOperationException("this collection is read only"); - } - - /* (non-Javadoc) - * @see java.util.Collection#containsAll(java.util.Collection) - */ - @Override - public boolean containsAll(Collection c) { - for (Object candidate : c) { - if (!contains(candidate)) { - return false; - } - } - - return true; - } - - /* (non-Javadoc) - * @see java.util.Collection#addAll(java.util.Collection) - */ - @Override - public boolean addAll(Collection c) { - throw new UnsupportedOperationException("this collection is read only"); - } - - /* (non-Javadoc) - * @see java.util.Collection#removeAll(java.util.Collection) - */ - @Override - public boolean removeAll(Collection c) { - throw new UnsupportedOperationException("this collection is read only"); - } - - /* (non-Javadoc) - * @see java.util.Collection#retainAll(java.util.Collection) - */ - @Override - public boolean retainAll(Collection c) { - throw new UnsupportedOperationException("this collection is read only"); - } - - /* (non-Javadoc) - * @see java.util.Collection#clear() - */ - @Override - public void clear() { - throw new UnsupportedOperationException("this collection is read only"); - } - - /* (non-Javadoc) - * @see java.util.Collection#iterator() - */ - @Override - public Iterator iterator() { - return new ReadOnlyCollectionIteratorFacade(list.iterator(), entryFacade); - } - - } - - /** - *

- * Implementation of an iterator to facade an iterator on the internal list of task instance - * entries. - *

- * - * @author Patrick Harms - */ - private class ReadOnlyCollectionIteratorFacade implements Iterator { - - /** - * the facaded iterator - */ - private Iterator> iterator; - - /** - * the facade for the entries provided by the facaded iterator - */ - private EntryFacade entryFacade; - - /** - *

- * initialized this facade with the facaded iterator and the entry facade to be used for - * the entries. - *

- */ - private ReadOnlyCollectionIteratorFacade(Iterator> iterator, - EntryFacade entryFacade) - { - this.iterator = iterator; - this.entryFacade = entryFacade; - } - - /* (non-Javadoc) - * @see java.util.Iterator#hasNext() - */ - @Override - public boolean hasNext() { - return iterator.hasNext(); - } - - /* (non-Javadoc) - * @see java.util.Iterator#next() - */ - @Override - public TYPE next() { - return entryFacade.getFacadedElement(iterator.next()); - } - - /* (non-Javadoc) - * @see java.util.Iterator#remove() - */ - @Override - public void remove() { - throw new UnsupportedOperationException("this iterator is read only"); - } - - } - - /** - *

- * Used to facade task instance entries and to return only this part of an entry, that is - * relevant. - *

- * - * @author Patrick Harms - */ - private abstract class EntryFacade { - - /** - *

- * Returns only the part of an entry that is relevant or required. - *

- * - * @param entry of which the part shall be returned - * - * @return the part of the entry to be returned - */ - protected abstract T getFacadedElement(Entry entry); - - } - - /** - *

- * Implementation of the entry facade returning the entries key, i.e. the symbol. - *

- * - * @author Patrick Harms - */ - private class SymbolFacade extends EntryFacade { - - /* (non-Javadoc) - * @see ReadOnlyCollectionIteratorFacade#getFacadedElement(Entry) - */ - @Override - protected ITaskInstance getFacadedElement(Entry entry) { - return entry.getKey(); - } - } - - /** - *

- * Implementation of the entry facade returning the entries value, i.e. the value associated to - * the symbol. - *

- * - * @author Patrick Harms - */ - private class ValueFacade extends EntryFacade { - - /* (non-Javadoc) - * @see ReadOnlyCollectionIteratorFacade#getFacadedElement(Entry) - */ - @Override - protected V getFacadedElement(Entry entry) { - return entry.getValue(); - } - } +class TaskSymbolBucketedMap implements SymbolMap, + Serializable { + + /** + *

+ * Used to facade task instance entries and to return only this part of an + * entry, that is relevant. + *

+ * + * @author Patrick Harms + */ + private abstract class EntryFacade { + + /** + *

+ * Returns only the part of an entry that is relevant or required. + *

+ * + * @param entry + * of which the part shall be returned + * + * @return the part of the entry to be returned + */ + protected abstract T getFacadedElement(Entry entry); + + } + + /** + *

+ * Used to create an efficient facade for accessing the internal list of + * entries either only for the task instances or only for the values. It is + * a default implementation of the collection interface. The entry facade + * provided to the constructor decides, if either the list accesses only the + * task instances or only the values. + *

+ * + * @author Patrick Harms + */ + private class ReadOnlyCollectionFacade implements Collection { + + /** + * the list facaded by this facade + */ + private final List> list; + + /** + * the facade to be used for the entries + */ + private final EntryFacade entryFacade; + + /** + *

+ * Initializes the facade with the facaded list and the facade to be + * used for the entries + *

+ */ + private ReadOnlyCollectionFacade( + List> list, + EntryFacade entryFacade) { + this.list = list; + this.entryFacade = entryFacade; + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#add(java.lang.Object) + */ + @Override + public boolean add(TYPE e) { + throw new UnsupportedOperationException( + "this collection is read only"); + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#addAll(java.util.Collection) + */ + @Override + public boolean addAll(Collection c) { + throw new UnsupportedOperationException( + "this collection is read only"); + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#clear() + */ + @Override + public void clear() { + throw new UnsupportedOperationException( + "this collection is read only"); + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#contains(java.lang.Object) + */ + @Override + public boolean contains(Object o) { + if (o == null) { + for (final Map.Entry entry : list) { + if (entryFacade.getFacadedElement(entry) == null) { + return true; + } + } + } else { + for (final Map.Entry entry : list) { + if (o.equals(entryFacade.getFacadedElement(entry))) { + return true; + } + } + } + + return false; + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#containsAll(java.util.Collection) + */ + @Override + public boolean containsAll(Collection c) { + for (final Object candidate : c) { + if (!contains(candidate)) { + return false; + } + } + + return true; + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#isEmpty() + */ + @Override + public boolean isEmpty() { + return list.isEmpty(); + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#iterator() + */ + @Override + public Iterator iterator() { + return new ReadOnlyCollectionIteratorFacade(list.iterator(), + entryFacade); + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#remove(java.lang.Object) + */ + @Override + public boolean remove(Object o) { + throw new UnsupportedOperationException( + "this collection is read only"); + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#removeAll(java.util.Collection) + */ + @Override + public boolean removeAll(Collection c) { + throw new UnsupportedOperationException( + "this collection is read only"); + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#retainAll(java.util.Collection) + */ + @Override + public boolean retainAll(Collection c) { + throw new UnsupportedOperationException( + "this collection is read only"); + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#size() + */ + @Override + public int size() { + return list.size(); + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#toArray() + */ + @Override + public Object[] toArray() { + final Object[] result = new Object[list.size()]; + + for (int i = 0; i < list.size(); i++) { + result[i] = entryFacade.getFacadedElement(list.get(i)); + } + + return result; + } + + /* + * (non-Javadoc) + * + * @see java.util.Collection#toArray(T[]) + */ + @SuppressWarnings("unchecked") + @Override + public T[] toArray(T[] a) { + final T[] result = a; + + for (int i = 0; i < list.size(); i++) { + result[i] = (T) entryFacade.getFacadedElement(list.get(i)); + } + + return result; + } + + } + + /** + *

+ * Implementation of an iterator to facade an iterator on the internal list + * of task instance entries. + *

+ * + * @author Patrick Harms + */ + private class ReadOnlyCollectionIteratorFacade implements + Iterator { + + /** + * the facaded iterator + */ + private final Iterator> iterator; + + /** + * the facade for the entries provided by the facaded iterator + */ + private final EntryFacade entryFacade; + + /** + *

+ * initialized this facade with the facaded iterator and the entry + * facade to be used for the entries. + *

+ */ + private ReadOnlyCollectionIteratorFacade( + Iterator> iterator, + EntryFacade entryFacade) { + this.iterator = iterator; + this.entryFacade = entryFacade; + } + + /* + * (non-Javadoc) + * + * @see java.util.Iterator#hasNext() + */ + @Override + public boolean hasNext() { + return iterator.hasNext(); + } + + /* + * (non-Javadoc) + * + * @see java.util.Iterator#next() + */ + @Override + public TYPE next() { + return entryFacade.getFacadedElement(iterator.next()); + } + + /* + * (non-Javadoc) + * + * @see java.util.Iterator#remove() + */ + @Override + public void remove() { + throw new UnsupportedOperationException( + "this iterator is read only"); + } + + } + + /** + *

+ * Implementation of the entry facade returning the entries key, i.e. the + * symbol. + *

+ * + * @author Patrick Harms + */ + private class SymbolFacade extends EntryFacade { + + /* + * (non-Javadoc) + * + * @see ReadOnlyCollectionIteratorFacade#getFacadedElement(Entry) + */ + @Override + protected ITaskInstance getFacadedElement(Entry entry) { + return entry.getKey(); + } + } + + /** + *

+ * Internally used data structure for storing task instance - value pairs + *

+ * + * @author Patrick Harms + */ + private class SymbolMapEntry implements Map.Entry { + + /** + * the task instance to map to a value + */ + private final ITaskInstance symbol; + + /** + * the value associated with the symbol + */ + private V value; + + /** + *

+ * Simple constructor for initializing the entry with a task instance + * and its associated value. + *

+ */ + private SymbolMapEntry(ITaskInstance symbol, V value) { + super(); + this.symbol = symbol; + this.value = value; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#equals(java.lang.Object) + */ + @SuppressWarnings("unchecked") + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } else if (this.getClass().isInstance(obj)) { + final SymbolMapEntry other = (SymbolMapEntry) obj; + return (symbol.equals(other.symbol) && (value == null ? other.value == null + : value.equals(other.value))); + } else { + return false; + } + } + + /* + * (non-Javadoc) + * + * @see java.util.Map.Entry#getKey() + */ + @Override + public ITaskInstance getKey() { + return symbol; + } + + /* + * (non-Javadoc) + * + * @see java.util.Map.Entry#getValue() + */ + @Override + public V getValue() { + return value; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + return symbol.hashCode(); + } + + /* + * (non-Javadoc) + * + * @see java.util.Map.Entry#setValue(java.lang.Object) + */ + @Override + public V setValue(V value) { + final V oldValue = this.value; + this.value = value; + return oldValue; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public String toString() { + return symbol + "=" + value; + } + + } + + /** + *

+ * Implementation of the entry facade returning the entries value, i.e. the + * value associated to the symbol. + *

+ * + * @author Patrick Harms + */ + private class ValueFacade extends EntryFacade { + + /* + * (non-Javadoc) + * + * @see ReadOnlyCollectionIteratorFacade#getFacadedElement(Entry) + */ + @Override + protected V getFacadedElement(Entry entry) { + return entry.getValue(); + } + } + + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; + + /** + *

+ * the maximum number of task instances in this map which is still only + * treated as list instead of using buckets. + *

+ */ + private static final int MAX_LIST_SIZE = 15; + + /** + *

+ * Comparator to be used for comparing the task instances with each other + *

+ */ + private final TaskInstanceComparator comparator; + + /** + *

+ * Internally maintained plain list of task instances and associated values + *

+ */ + private final List> symbolList; + + /** + *

+ * If the size of the map exceeds {@link #MAX_LIST_SIZE}, this is the index + * using buckets for optimizing the search order. + *

+ */ + private Map>> symbolBuckets; + + /** + *

+ * When using buckets, not any task instance may be associated a correct + * bucket. Therefore, we set a default bucket for all such task instances. + * This may change if the same bucket for a specific symbol is selected. + *

+ */ + private int defaultBucket = 0; + + /** + *

+ * Instantiates a task instance map with a comparator + *

+ * + * @param comparator + * the comparator to use for comparing task instances + * + * @throws IllegalArgumentException + * if the provided comparator is null + */ + public TaskSymbolBucketedMap(TaskInstanceComparator comparator) { + if (comparator == null) { + throw new IllegalArgumentException("comparator must not be null"); + } + + this.comparator = comparator; + this.symbolList = new ArrayList>(); + } + + /** + *

+ * Copy constructor + *

+ * + * @param otherMap + * the other map to be copied including its comparator + * + * @throws IllegalArgumentException + * if the provided other map is null + */ + public TaskSymbolBucketedMap(TaskSymbolBucketedMap otherMap) { + if (otherMap == null) { + throw new IllegalArgumentException("otherMap must not be null"); + } + + this.comparator = otherMap.comparator; + this.symbolList = new ArrayList>( + otherMap.symbolList); + + if (this.symbolList.size() > MAX_LIST_SIZE) { + createSymbolBuckets(); + } + } + + /** + *

+ * Adds a task instance and an associated value to the map. If the value is + * null, the task instance is added, anyway and + * {@link #containsSymbol(Object)} will return true for that task instance. + * Adding the same task instance twice will produce two entries. This is + * contradictory to typical map implementations. To prevent this, the + * {@link #containsSymbol(Object)} and {@link #removeSymbol(Object)} methods + * should be used to ensure map behavior. + *

+ * + * @param symbol + * the task instance to add to the map + * @param value + * the value to associate to the task instance in this map + * + * @return as described + * + * @throws IllegalArgumentException + * if the provided task instance is null + */ + @Override + public void addSymbol(ITaskInstance symbol, V value) { + if (symbol == null) { + throw new IllegalArgumentException("symbol must not be null"); + } + + final Map.Entry entry = new SymbolMapEntry(symbol, + value); + + symbolList.add(entry); + + if (symbolList.size() > MAX_LIST_SIZE) { + if (symbolBuckets == null) { + createSymbolBuckets(); + } else { + addToSymbolBucket(entry); + } + } + } + + /** + *

+ * Adds a task instance and its value to its corresponding bucket. The + * corresponding bucket is the first element of the array returned by the + * method {@link #getBucketSearchOrder(ITaskInstance)}. If no search order + * for a task instance is defined, the entry is added to the default bucket. + * If the bucket id identical to the default bucket id, the default bucket + * id is shifted to another value. + *

+ */ + private void addToSymbolBucket(Map.Entry symbolEntry) { + int bucketId = defaultBucket; + final int[] bucketSearchOrder = getBucketSearchOrder(symbolEntry + .getKey()); + + if ((bucketSearchOrder != null) && (bucketSearchOrder.length > 0)) { + bucketId = bucketSearchOrder[0]; + + if (bucketId == defaultBucket) { + setNewDefaultBucketId(); + } + } + + List> list = symbolBuckets.get(bucketId); + + if (list == null) { + list = new LinkedList>(); + symbolBuckets.put(bucketId, list); + } + + list.add(symbolEntry); + } + + /** + *

+ * Removes all task instances and associated values from the map. + *

+ */ + @Override + public void clear() { + symbolList.clear(); + symbolBuckets = null; + } + + /** + *

+ * Returns true if the provided task instance was stored in this map. + *

+ * + * @param symbol + * the task instance to check if it was stored in this map + * + * @return as described + * + * @throws IllegalArgumentException + * if the provided task instance is null + */ + @Override + public boolean containsSymbol(ITaskInstance symbol) { + if (symbol == null) { + throw new IllegalArgumentException("symbol must not be null"); + } + + return getEntry(symbol) != null; + } + + /** + *

+ * Internally used to create task instance buckets in case the number of + * stored task instances increased above {@link #MAX_LIST_SIZE}. + *

+ */ + private void createSymbolBuckets() { + // System.out.println("creating symbol buckets"); + symbolBuckets = new HashMap>>(); + + for (final Map.Entry symbol : symbolList) { + addToSymbolBucket(symbol); + } + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#equals(java.lang.Object) + */ + @SuppressWarnings("unchecked") + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } else if (this.getClass().isInstance(obj)) { + final TaskSymbolBucketedMap other = (TaskSymbolBucketedMap) obj; + + return (symbolList.size() == other.symbolList.size()) + && (symbolList.containsAll(other.symbolList)); + } else { + return false; + } + } + + /** + *

+ * returns the search order for a task instance which is different for event + * task instances, sequence instances, selection instances, and iteration + * instances + *

+ */ + private int[] getBucketSearchOrder(ITaskInstance taskInstance) { + // 0 = sequence; 1 = selection; 2 = iteration; 3 = optional; 4 = event + // task in general; + // other = hashCode of name of event type + + if (taskInstance instanceof IEventTaskInstance) { + // event tasks are most likely equal to those of the same type + // happening on the same + // target. Afterwards, they should be equal to those of the event + // type with the same + // name. Afterwards, they may be equal to iterations, optionals, + // other event tasks, + // selections, and finally the rest. + final Event event = ((IEventTaskInstance) taskInstance).getEvent(); + return new int[] { + event.getTarget().hashCode() + + event.getType().getName().hashCode(), + event.getType().getName().hashCode(), 2, 3, 4, 1 }; + } else if (taskInstance instanceof ISequenceInstance) { + return new int[] { 0, 2, 3, 1 }; + } else if (taskInstance instanceof ISelectionInstance) { + return new int[] { 1, 4, 2, 3 }; + } else if (taskInstance instanceof IIterationInstance) { + return new int[] { 2, 1, 4 }; + } + + return null; + } + + /** + *

+ * searches for the entry belonging to the given task instance. The method + * either uses the list if buckets are not used yet, or it uses the buckets + * and searches them in the order defined by the method + * {@link #getBucketSearchOrder(ITaskInstance)}. If the task instances isn't + * found and the bucket search order does not refer all buckets, then also + * the other buckets are searched for the task instance. + *

+ */ + private Map.Entry getEntry(ITaskInstance symbol) { + Map.Entry entry = null; + if (symbolBuckets == null) { + entry = lookup(symbol, symbolList); + } else { + final int[] bucketSearchOrder = getBucketSearchOrder(symbol); + for (final int bucketId : bucketSearchOrder) { + final List> list = symbolBuckets + .get(bucketId); + if (list != null) { + entry = lookup(symbol, list); + if (entry != null) { + break; + } + } + } + + // try to search the other buckets + if (entry == null) { + Arrays.sort(bucketSearchOrder); + for (final Map.Entry>> bucket : symbolBuckets + .entrySet()) { + if (Arrays.binarySearch(bucketSearchOrder, bucket.getKey()) < 0) { + final List> list = bucket + .getValue(); + if (list != null) { + entry = lookup(symbol, list); + if (entry != null) { + break; + } + } + } + } + } + } + + return entry; + } + + /** + *

+ * Returns a collection of all task instances in this map. + *

+ * + * @return as described + */ + @Override + public Collection getSymbols() { + return new ReadOnlyCollectionFacade(symbolList, + new SymbolFacade()); + } + + /** + *

+ * Returns the value associated to the provided task instance in this map. + * If there is no value associated to the given task instance or if the task + * instance is not stored in this map, the method returns null. + *

+ * + * @param symbol + * the task instance to return the value for + * + * @return as described + * + * @throws IllegalArgumentException + * if the provided task instance is null + */ + @Override + public V getValue(ITaskInstance symbol) { + if (symbol == null) { + throw new IllegalArgumentException("symbol must not be null"); + } + + final Map.Entry entry = getEntry(symbol); + + if (entry != null) { + return entry.getValue(); + } else { + return null; + } + } + + /** + *

+ * Returns a collection of all values associated to task instances in this + * map. May contain null values, if some of the task instances are mapped to + * null. The length of the returned collection is in any case the same as + * the size of the map. + *

+ * + * @return as described + */ + @Override + public Collection getValues() { + return new ReadOnlyCollectionFacade(symbolList, new ValueFacade()); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + return symbolList.size(); + } + + /** + *

+ * Returns true if this map is empty, i.e. if {@link #size()} returns 0 + *

+ * + * @return as described + */ + @Override + public boolean isEmpty() { + return symbolList.isEmpty(); + } + + /** + *

+ * Convenience method to look up a symbol in a list of entries using the + * comparator. + *

+ */ + private Map.Entry lookup(ITaskInstance symbol, + List> list) { + for (final Map.Entry candidate : list) { + if (comparator.equals(candidate.getKey(), symbol)) { + return candidate; + } + } + + return null; + } + + /** + *

+ * Removes the entry for a given task instance from the buckets. It uses the + * bucket search order defined to find the task instance as fast as + * possible. + *

+ */ + private Map.Entry removeFromSymbolBuckets( + ITaskInstance symbol) { + int bucketId = defaultBucket; + final int[] bucketSearchOrder = getBucketSearchOrder(symbol); + + if ((bucketSearchOrder != null) && (bucketSearchOrder.length > 0)) { + bucketId = bucketSearchOrder[0]; + } + + final List> list = symbolBuckets + .get(bucketId); + Map.Entry result = null; + + if (list != null) { + for (int i = 0; i < list.size(); i++) { + if (comparator.equals(list.get(i).getKey(), symbol)) { + result = list.remove(i); + break; + } + } + + if (list.isEmpty()) { + symbolBuckets.remove(bucketId); + } + } + + return result; + } + + /** + *

+ * Removes a task instance and its associated value from the map. If the + * task instance is stored several times, only the first of its occurrences + * is removed. + *

+ * + * @param symbol + * the task instance to be removed from the map + * + * @return as described + * + * @throws IllegalArgumentException + * if the provided task instance is null + */ + @Override + public V removeSymbol(ITaskInstance symbol) { + if (symbol == null) { + throw new IllegalArgumentException("symbol must not be null"); + } + + for (int i = 0; i < symbolList.size(); i++) { + if (comparator.equals(symbolList.get(i).getKey(), symbol)) { + // found the symbol. Remove it from the list, and if required, + // also from the map. + final V value = symbolList.remove(i).getValue(); + + if (symbolList.size() > MAX_LIST_SIZE) { + removeFromSymbolBuckets(symbol); + } + + return value; + } + } + + return null; + } + + /** + *

+ * Updates the default bucket id to a new one + *

+ */ + private void setNewDefaultBucketId() { + final int oldDefaultBucket = defaultBucket; + do { + defaultBucket += 1; + } while (symbolBuckets.containsKey(defaultBucket)); + + symbolBuckets + .put(defaultBucket, symbolBuckets.remove(oldDefaultBucket)); + } + + /** + *

+ * Returns the size of the map, i.e. the number of task instance entries + *

+ * + * @return as described + */ + @Override + public int size() { + return symbolList.size(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskSymbolIdentityMap.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskSymbolIdentityMap.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TaskSymbolIdentityMap.java (revision 1733) @@ -25,6 +25,6 @@ /** *

- * symbol map implementation for task instances considering two task instances as equal if their - * tasks are identical + * symbol map implementation for task instances considering two task instances + * as equal if their tasks are identical *

* @@ -33,166 +33,195 @@ public class TaskSymbolIdentityMap implements SymbolMap { - /** */ - private static final long serialVersionUID = 1L; - - /** - *

- * internally used map for implementing the symbol map interface - *

- */ - private Map delegate; - - /** - *

- * mapping between the tasks and the real symbols stored in the map, i.e. the task instances - *

- */ - private Map symbols; - - /** - *

- * initializes this map - *

- */ - public TaskSymbolIdentityMap() { - delegate = new HashMap(); - symbols = new HashMap(); - } - - /** - *

- * copy constructor - *

- * - * @param other the map to be copied - */ - public TaskSymbolIdentityMap(SymbolMap other) { - if (other == null) { - throw new IllegalArgumentException("other map must not be null"); - } - - delegate = new HashMap(); - symbols = new HashMap(); - - for (ITaskInstance symbol : other.getSymbols()) { - delegate.put(symbol.getTask(), other.getValue(symbol)); - symbols.put(symbol.getTask(), symbol); - } - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#size() - */ - @Override - public int size() { - return delegate.size(); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#isEmpty() - */ - @Override - public boolean isEmpty() { - return delegate.isEmpty(); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#containsSymbol(java.lang.Object) - */ - @Override - public boolean containsSymbol(ITaskInstance symbol) { - if (symbol == null) { - throw new IllegalArgumentException("symbol must not be null"); - } - - return delegate.containsKey(symbol.getTask()); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#getValue(java.lang.Object) - */ - @Override - public V getValue(ITaskInstance symbol) { - if (symbol == null) { - throw new IllegalArgumentException("symbol must not be null"); - } - - return delegate.get(symbol.getTask()); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#addSymbol(java.lang.Object, java.lang.Object) - */ - @Override - public void addSymbol(ITaskInstance symbol, V value) { - if (symbol == null) { - throw new IllegalArgumentException("symbol must not be null"); - } - - delegate.put(symbol.getTask(), value); - symbols.put(symbol.getTask(), symbol); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#removeSymbol(java.lang.Object) - */ - @Override - public V removeSymbol(ITaskInstance symbol) { - if (symbol == null) { - throw new IllegalArgumentException("symbol must not be null"); - } - - symbols.remove(symbol.getTask()); - return delegate.remove(symbol.getTask()); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#getSymbols() - */ - @Override - public Collection getSymbols() { - return symbols.values(); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#getValues() - */ - @Override - public Collection getValues() { - return delegate.values(); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#clear() - */ - @Override - public void clear() { - delegate.clear(); - } - - /* (non-Javadoc) - * @see java.lang.Object#hashCode() - */ - @Override - public int hashCode() { - return delegate.hashCode(); - } - - /* (non-Javadoc) - * @see java.lang.Object#equals(java.lang.Object) - */ - @SuppressWarnings("unchecked") - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - else if (this.getClass().isInstance(obj)) { - return delegate.equals(((TaskSymbolIdentityMap) obj).delegate); - } - else { - return false; - } - } + /** */ + private static final long serialVersionUID = 1L; + + /** + *

+ * internally used map for implementing the symbol map interface + *

+ */ + private final Map delegate; + + /** + *

+ * mapping between the tasks and the real symbols stored in the map, i.e. + * the task instances + *

+ */ + private final Map symbols; + + /** + *

+ * initializes this map + *

+ */ + public TaskSymbolIdentityMap() { + delegate = new HashMap(); + symbols = new HashMap(); + } + + /** + *

+ * copy constructor + *

+ * + * @param other + * the map to be copied + */ + public TaskSymbolIdentityMap(SymbolMap other) { + if (other == null) { + throw new IllegalArgumentException("other map must not be null"); + } + + delegate = new HashMap(); + symbols = new HashMap(); + + for (final ITaskInstance symbol : other.getSymbols()) { + delegate.put(symbol.getTask(), other.getValue(symbol)); + symbols.put(symbol.getTask(), symbol); + } + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.usageprofiles.SymbolMap#addSymbol(java.lang.Object, + * java.lang.Object) + */ + @Override + public void addSymbol(ITaskInstance symbol, V value) { + if (symbol == null) { + throw new IllegalArgumentException("symbol must not be null"); + } + + delegate.put(symbol.getTask(), value); + symbols.put(symbol.getTask(), symbol); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#clear() + */ + @Override + public void clear() { + delegate.clear(); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.usageprofiles.SymbolMap#containsSymbol(java.lang + * .Object) + */ + @Override + public boolean containsSymbol(ITaskInstance symbol) { + if (symbol == null) { + throw new IllegalArgumentException("symbol must not be null"); + } + + return delegate.containsKey(symbol.getTask()); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#equals(java.lang.Object) + */ + @SuppressWarnings("unchecked") + @Override + public boolean equals(Object obj) { + if (this == obj) { + return true; + } else if (this.getClass().isInstance(obj)) { + return delegate.equals(((TaskSymbolIdentityMap) obj).delegate); + } else { + return false; + } + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#getSymbols() + */ + @Override + public Collection getSymbols() { + return symbols.values(); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.usageprofiles.SymbolMap#getValue(java.lang.Object) + */ + @Override + public V getValue(ITaskInstance symbol) { + if (symbol == null) { + throw new IllegalArgumentException("symbol must not be null"); + } + + return delegate.get(symbol.getTask()); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#getValues() + */ + @Override + public Collection getValues() { + return delegate.values(); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + return delegate.hashCode(); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#isEmpty() + */ + @Override + public boolean isEmpty() { + return delegate.isEmpty(); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.usageprofiles.SymbolMap#removeSymbol(java.lang.Object + * ) + */ + @Override + public V removeSymbol(ITaskInstance symbol) { + if (symbol == null) { + throw new IllegalArgumentException("symbol must not be null"); + } + + symbols.remove(symbol.getTask()); + return delegate.remove(symbol.getTask()); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.usageprofiles.SymbolMap#size() + */ + @Override + public int size() { + return delegate.size(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TemporalRelationshipRuleManager.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TemporalRelationshipRuleManager.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/temporalrelation/TemporalRelationshipRuleManager.java (revision 1733) @@ -33,51 +33,50 @@ * *

- * This class is responsible for applying temporal relationship rules on a task tree. Through this, - * a flat task tree is restructured to have more depth but to include more temporal relationships - * between tasks which are not only a major sequence. I.e. through the application of the - * rules iterations and selections of tasks are detected. Which kind of temporal relations - * between tasks are detected depends on the {@link ITaskInstanceScopeRule}s known to + * This class is responsible for applying temporal relationship rules on a task + * tree. Through this, a flat task tree is restructured to have more depth but + * to include more temporal relationships between tasks which are not only a + * major sequence. I.e. through the application of the rules iterations and + * selections of tasks are detected. Which kind of temporal relations between + * tasks are detected depends on the {@link ITaskInstanceScopeRule}s known to * this class. *

- *

The class holds references to the appropriate {@link ITaskInstanceScopeRule}s and calls - * their {@link ITaskInstanceScopeRule#apply(ITask, ITaskBuilder, ITaskFactory, boolean)} - * method for each task in the task tree it is needed for. The general behavior of this class is - * the following: + *

+ * The class holds references to the appropriate {@link ITaskInstanceScopeRule}s + * and calls their + * {@link ITaskInstanceScopeRule#apply(ITask, ITaskBuilder, ITaskFactory, boolean)} + * method for each task in the task tree it is needed for. The general behavior + * of this class is the following: *

    - *
  1. - * An instance of this class is created using the constructor and calling the - * {@link #init()} method afterwards - *
    2. - *
  2. - * then the {@link #applyRules(ITask, ITaskBuilder, ITaskFactory, boolean)} - * method is called for a so far unstructured task - *
    3. - *
  3. - * the class iterates its internal list of rules and calls their - * {@link ITaskInstanceScopeRule#apply(ITask, ITaskBuilder, ITaskFactory, boolean)} - * method. - *
    4. - *
  4. - * the class evaluates the rule application result - *
      - *
    • - * if a rule returns a rule application result that is null, the next rule is tried - *
      • - *
    • - * if a rule returns that it would be feasible if more data was available and the rule - * application shall not be finalized (see finalize parameter of the applyRules method) - * the rule application is broken up - *
      • - *
    • - * if a rule returns, that it was applied, the same rule is applied again until it returns - * null or feasible. For each newly created parent task provided in the rule application - * result, the {@link #applyRules(ITask, ITaskBuilder, ITaskFactory, boolean)} - * method is called. - *
      • - *
    - *
    5. + *
  5. + * An instance of this class is created using the constructor and calling the + * {@link #init()} method afterwards
    6. + *
  6. + * then the {@link #applyRules(ITask, ITaskBuilder, ITaskFactory, boolean)} + * method is called for a so far unstructured task
    7. + *
  7. + * the class iterates its internal list of rules and calls their + * {@link ITaskInstanceScopeRule#apply(ITask, ITaskBuilder, ITaskFactory, boolean)} + * method.
    8. + *
  8. + * the class evaluates the rule application result + *
      + *
    • + * if a rule returns a rule application result that is null, the next rule is + * tried
      • + *
    • + * if a rule returns that it would be feasible if more data was available and + * the rule application shall not be finalized (see finalize parameter of the + * applyRules method) the rule application is broken up
      • + *
    • + * if a rule returns, that it was applied, the same rule is applied again until + * it returns null or feasible. For each newly created parent task provided in + * the rule application result, the + * {@link #applyRules(ITask, ITaskBuilder, ITaskFactory, boolean)} method is + * called.
      • + *
    + *
    9. *
- * Through this, all rules are tried to be applied at least once to the provided parent task and - * all parent tasks created during the rule application. + * Through this, all rules are tried to be applied at least once to the provided + * parent task and all parent tasks created during the rule application. *

* @@ -85,243 +84,255 @@ */ public class TemporalRelationshipRuleManager { - - /** - *

- * the task factory to be used during rule application - *

- */ - private ITaskFactory taskFactory; - - /** - *

- * the task builder to be used during rule application - *

- */ - private ITaskBuilder taskBuilder; - - /** - *

- * the temporal relationship rules known to the manager that are executed on whole sessions. - * The rules are applied in the order they occur in this list. - *

- */ - private ISessionScopeRule[] sessionScopeRules; - - /** - *

- * the temporal relationship rules known to the manager that are executed on whole sub trees. - * The rules are applied in the order they occur in this list. - *

- */ - private ITaskInstanceScopeRule[] taskScopeRules; - - /** - *

- * initialize the manager - *

- * - * @param taskFactory the task factory to be used for instantiating new task tree - * tasks during rule application - * @param taskBuilder the task builder to be used for linking tasks - * with each other during rule application - */ - public TemporalRelationshipRuleManager(ITaskFactory taskFactory, ITaskBuilder taskBuilder) { - super(); - this.taskFactory = taskFactory; - this.taskBuilder = taskBuilder; - } - - /** - *

- * initialized the temporal relationship rule manager by instantiating the known rules and - * providing them with a reference to the task equality manager or other information they need. - *

- */ - public void init() { - List> frameFilter = - new ArrayList>(); - frameFilter.add(IFrame.class); - frameFilter.add(IDialog.class); - //frameFilter.add(ICanvas.class); - - sessionScopeRules = new ISessionScopeRule[] { - new SequenceForTaskDetectionRuleAlignment - (TaskEquality.SEMANTICALLY_EQUAL, taskFactory, taskBuilder), - /*new DefaultTaskSequenceDetectionRule - (NodeEquality.SYNTACTICALLY_EQUAL, taskFactory, taskTreeBuilder), - new DefaultTaskSequenceDetectionRule - (NodeEquality.LEXICALLY_EQUAL, taskFactory, taskTreeBuilder),*/ - /*new TreeScopeWrapperRule - (new DefaultIterationDetectionRule - (NodeEquality.LEXICALLY_EQUAL, taskFactory, taskTreeBuilder)), - new TreeScopeWrapperRule - (new DefaultIterationDetectionRule - (NodeEquality.SYNTACTICALLY_EQUAL, taskFactory, taskTreeBuilder)), - new TreeScopeWrapperRule - (new DefaultIterationDetectionRule - (NodeEquality.SEMANTICALLY_EQUAL, taskFactory, taskTreeBuilder))*/ - }; - - //treeScopeRules.add(new DefaultGuiElementSequenceDetectionRule(frameFilter)); - - taskScopeRules = new ITaskInstanceScopeRule[] { - //new SequenceOnGuiElementDetectionRule(taskFactory, taskTreeBuilder), - //new EventSequenceOnSameTargetDetectionRule(taskFactory, taskTreeBuilder), - //new TrackBarSelectionDetectionRule(taskFactory, taskBuilder), - //new DefaultGuiEventSequenceDetectionRule(taskFactory, taskTreeBuilder), - }; - - } - - /** - *

- * applies the known rules to the provided sessions. For the creation of further tasks, - * the provided builder and task factory are utilized. The method expects, that no more data - * is available and, therefore, finalizes the rule application. - *

- * - * @param taskFactory the task factory to be used for instantiating new tasks. - */ - public void applyRules(List sessions) { - applyRules(sessionScopeRules, sessions, ""); - } - - /** - *

- * applies the known rules to the provided parent task. For the creation of further tasks, - * the provided builder and task factory are utilized. If the finalize parameter is true, the - * rule application is finalized as far as possible without waiting for further data. If it is - * false, the rule application is broken up at the first rule returning, that its application - * would be feasible. The method calls itself for each parent task created through the rule - * application. In this case, the finalize parameter is always true. - *

- * - * @param parent the parent task to apply the rules on - * @param finalize used to indicate, if the rule application shall break up if a rule would - * be feasible if further data was available, or not. - * @param logIndent simply used for logging purposes to indent the log messages depending - * on the recursion depth of calling this method. - */ - private int applyRules(ISessionScopeRule[] rules, - List sessions, - String logIndent) - { - Console.traceln - (Level.FINER, logIndent + "applying rules for " + sessions.size() + " sessions"); - - int noOfRuleApplications = 0; - - for (ISessionScopeRule rule : rules) { - RuleApplicationResult result; - do { - Console.traceln(Level.FINER, logIndent + "trying rule " + rule); - result = rule.apply(sessions); - - if ((result != null) && - (result.getRuleApplicationStatus() == RuleApplicationStatus.FINISHED)) - { - Console.traceln(Level.FINE, logIndent + "applied rule " + rule); - noOfRuleApplications++; - - //dumpTask(parent, ""); - - for (ITaskInstance newParent : result.getNewlyCreatedTaskInstances()) { - noOfRuleApplications += - applyRules(taskScopeRules, newParent, logIndent + " "); - } - } - } - while ((result != null) && - (result.getRuleApplicationStatus() == RuleApplicationStatus.FINISHED)); - - } - - if (noOfRuleApplications <= 0) { - Console.traceln(Level.FINE, logIndent + "no rules applied --> no temporal " + - "relationship generated"); - } - - return noOfRuleApplications; - } - - /** - *

- * applies the known rules to the provided parent task. For the creation of further tasks, - * the provided builder and task factory are utilized. If the finalize parameter is true, the - * rule application is finalized as far as possible without waiting for further data. If it is - * false, the rule application is broken up at the first rule returning, that its application - * would be feasible. The method calls itself for each parent task created through the rule - * application. In this case, the finalize parameter is always true. - *

- * - * @param parent the parent task to apply the rules on - * @param finalize used to indicate, if the rule application shall break up if a rule would - * be feasible if further data was available, or not. - * @param logIndent simply used for logging purposes to indent the log messages depending - * on the recursion depth of calling this method. - */ - private int applyRules(ITaskInstanceScopeRule[] rules, - ITaskInstance taskInstance, - String logIndent) - { - Console.traceln(Level.FINER, logIndent + "applying rules on " + taskInstance); - - int noOfRuleApplications = 0; - - for (ITaskInstanceScopeRule rule : rules) { - RuleApplicationResult result; - do { - Console.traceln - (Level.FINER, logIndent + "trying rule " + rule + " on " + taskInstance); - result = rule.apply(taskInstance); - - if ((result != null) && - (result.getRuleApplicationStatus() == RuleApplicationStatus.FINISHED)) - { - Console.traceln - (Level.FINE, logIndent + "applied rule " + rule + " on " + taskInstance); - noOfRuleApplications++; - - //dumpTask(parent, ""); - - for (ITaskInstance newParent : result.getNewlyCreatedTaskInstances()) { - noOfRuleApplications += - applyRules(taskScopeRules, newParent, logIndent + " "); - } - } - } - while ((result != null) && - (result.getRuleApplicationStatus() == RuleApplicationStatus.FINISHED)); - } - - if (noOfRuleApplications <= 0) { - Console.traceln(Level.FINE, logIndent + "no rules applied --> no temporal " + - "relationship generated"); - } - - return noOfRuleApplications; - } - - /** - * - */ - /*private void dumpTask(ITask task, String indent) { - StringBuffer message = new StringBuffer(); - message.append(indent); - message.append(task); - if (task.getDescription() != null) { - message.append('('); - message.append(task.getDescription()); - message.append(')'); - } - - Console.traceln(Level.FINER, message.toString()); - - if ((task.getChildren() != null) && (task.getChildren().size() > 0)) { - for (ITask child : task.getChildren()) { - dumpTask(child, indent + " "); - } - } - }*/ + + /** + *

+ * the task factory to be used during rule application + *

+ */ + private final ITaskFactory taskFactory; + + /** + *

+ * the task builder to be used during rule application + *

+ */ + private final ITaskBuilder taskBuilder; + + /** + *

+ * the temporal relationship rules known to the manager that are executed on + * whole sessions. The rules are applied in the order they occur in this + * list. + *

+ */ + private ISessionScopeRule[] sessionScopeRules; + + /** + *

+ * the temporal relationship rules known to the manager that are executed on + * whole sub trees. The rules are applied in the order they occur in this + * list. + *

+ */ + private ITaskInstanceScopeRule[] taskScopeRules; + + /** + *

+ * initialize the manager + *

+ * + * @param taskFactory + * the task factory to be used for instantiating new task tree + * tasks during rule application + * @param taskBuilder + * the task builder to be used for linking tasks with each other + * during rule application + */ + public TemporalRelationshipRuleManager(ITaskFactory taskFactory, + ITaskBuilder taskBuilder) { + super(); + this.taskFactory = taskFactory; + this.taskBuilder = taskBuilder; + } + + /** + *

+ * applies the known rules to the provided parent task. For the creation of + * further tasks, the provided builder and task factory are utilized. If the + * finalize parameter is true, the rule application is finalized as far as + * possible without waiting for further data. If it is false, the rule + * application is broken up at the first rule returning, that its + * application would be feasible. The method calls itself for each parent + * task created through the rule application. In this case, the finalize + * parameter is always true. + *

+ * + * @param parent + * the parent task to apply the rules on + * @param finalize + * used to indicate, if the rule application shall break up if a + * rule would be feasible if further data was available, or not. + * @param logIndent + * simply used for logging purposes to indent the log messages + * depending on the recursion depth of calling this method. + */ + private int applyRules(ISessionScopeRule[] rules, + List sessions, String logIndent) { + Console.traceln(Level.FINER, logIndent + "applying rules for " + + sessions.size() + " sessions"); + + int noOfRuleApplications = 0; + + for (final ISessionScopeRule rule : rules) { + RuleApplicationResult result; + do { + Console.traceln(Level.FINER, logIndent + "trying rule " + rule); + result = rule.apply(sessions); + + if ((result != null) + && (result.getRuleApplicationStatus() == RuleApplicationStatus.FINISHED)) { + Console.traceln(Level.FINE, logIndent + "applied rule " + + rule); + noOfRuleApplications++; + + // dumpTask(parent, ""); + + for (final ITaskInstance newParent : result + .getNewlyCreatedTaskInstances()) { + noOfRuleApplications += applyRules(taskScopeRules, + newParent, logIndent + " "); + } + } + } while ((result != null) + && (result.getRuleApplicationStatus() == RuleApplicationStatus.FINISHED)); + + } + + if (noOfRuleApplications <= 0) { + Console.traceln(Level.FINE, logIndent + + "no rules applied --> no temporal " + + "relationship generated"); + } + + return noOfRuleApplications; + } + + /** + *

+ * applies the known rules to the provided parent task. For the creation of + * further tasks, the provided builder and task factory are utilized. If the + * finalize parameter is true, the rule application is finalized as far as + * possible without waiting for further data. If it is false, the rule + * application is broken up at the first rule returning, that its + * application would be feasible. The method calls itself for each parent + * task created through the rule application. In this case, the finalize + * parameter is always true. + *

+ * + * @param parent + * the parent task to apply the rules on + * @param finalize + * used to indicate, if the rule application shall break up if a + * rule would be feasible if further data was available, or not. + * @param logIndent + * simply used for logging purposes to indent the log messages + * depending on the recursion depth of calling this method. + */ + private int applyRules(ITaskInstanceScopeRule[] rules, + ITaskInstance taskInstance, String logIndent) { + Console.traceln(Level.FINER, logIndent + "applying rules on " + + taskInstance); + + int noOfRuleApplications = 0; + + for (final ITaskInstanceScopeRule rule : rules) { + RuleApplicationResult result; + do { + Console.traceln(Level.FINER, logIndent + "trying rule " + rule + + " on " + taskInstance); + result = rule.apply(taskInstance); + + if ((result != null) + && (result.getRuleApplicationStatus() == RuleApplicationStatus.FINISHED)) { + Console.traceln(Level.FINE, logIndent + "applied rule " + + rule + " on " + taskInstance); + noOfRuleApplications++; + + // dumpTask(parent, ""); + + for (final ITaskInstance newParent : result + .getNewlyCreatedTaskInstances()) { + noOfRuleApplications += applyRules(taskScopeRules, + newParent, logIndent + " "); + } + } + } while ((result != null) + && (result.getRuleApplicationStatus() == RuleApplicationStatus.FINISHED)); + } + + if (noOfRuleApplications <= 0) { + Console.traceln(Level.FINE, logIndent + + "no rules applied --> no temporal " + + "relationship generated"); + } + + return noOfRuleApplications; + } + + /** + *

+ * applies the known rules to the provided sessions. For the creation of + * further tasks, the provided builder and task factory are utilized. The + * method expects, that no more data is available and, therefore, finalizes + * the rule application. + *

+ * + * @param taskFactory + * the task factory to be used for instantiating new tasks. + */ + public void applyRules(List sessions) { + applyRules(sessionScopeRules, sessions, ""); + } + + /** + *

+ * initialized the temporal relationship rule manager by instantiating the + * known rules and providing them with a reference to the task equality + * manager or other information they need. + *

+ */ + public void init() { + final List> frameFilter = new ArrayList>(); + frameFilter.add(IFrame.class); + frameFilter.add(IDialog.class); + // frameFilter.add(ICanvas.class); + + sessionScopeRules = new ISessionScopeRule[] { new SequenceForTaskDetectionRuleAlignment( + TaskEquality.SEMANTICALLY_EQUAL, taskFactory, taskBuilder), + /* + * new DefaultTaskSequenceDetectionRule + * (NodeEquality.SYNTACTICALLY_EQUAL, taskFactory, taskTreeBuilder), new + * DefaultTaskSequenceDetectionRule (NodeEquality.LEXICALLY_EQUAL, + * taskFactory, taskTreeBuilder), + */ + /* + * new TreeScopeWrapperRule (new DefaultIterationDetectionRule + * (NodeEquality.LEXICALLY_EQUAL, taskFactory, taskTreeBuilder)), new + * TreeScopeWrapperRule (new DefaultIterationDetectionRule + * (NodeEquality.SYNTACTICALLY_EQUAL, taskFactory, taskTreeBuilder)), + * new TreeScopeWrapperRule (new DefaultIterationDetectionRule + * (NodeEquality.SEMANTICALLY_EQUAL, taskFactory, taskTreeBuilder)) + */ + }; + + // treeScopeRules.add(new + // DefaultGuiElementSequenceDetectionRule(frameFilter)); + + taskScopeRules = new ITaskInstanceScopeRule[] { + // new SequenceOnGuiElementDetectionRule(taskFactory, taskTreeBuilder), + // new EventSequenceOnSameTargetDetectionRule(taskFactory, + // taskTreeBuilder), + // new TrackBarSelectionDetectionRule(taskFactory, taskBuilder), + // new DefaultGuiEventSequenceDetectionRule(taskFactory, + // taskTreeBuilder), + }; + + } + + /** + * + */ + /* + * private void dumpTask(ITask task, String indent) { StringBuffer message = + * new StringBuffer(); message.append(indent); message.append(task); if + * (task.getDescription() != null) { message.append('('); + * message.append(task.getDescription()); message.append(')'); } + * + * Console.traceln(Level.FINER, message.toString()); + * + * if ((task.getChildren() != null) && (task.getChildren().size() > 0)) { + * for (ITask child : task.getChildren()) { dumpTask(child, indent + " "); + * } } } + */ } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/DefaultTaskInstanceTraversingVisitor.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/DefaultTaskInstanceTraversingVisitor.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/DefaultTaskInstanceTraversingVisitor.java (revision 1733) @@ -17,87 +17,103 @@ /** *

- * Default implementation for a task instance visitor performing a traversal of the instances + * Default implementation for a task instance visitor performing a traversal of + * the instances *

* * @author Patrick Harms */ -public class DefaultTaskInstanceTraversingVisitor implements ITaskInstanceVisitor { +public class DefaultTaskInstanceTraversingVisitor implements + ITaskInstanceVisitor { - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit(IEventTaskInstance) - */ - @Override - public void visit(IEventTaskInstance eventTaskInstance) { - // do nothing - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit( + * IEventTaskInstance) + */ + @Override + public void visit(IEventTaskInstance eventTaskInstance) { + // do nothing + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit(IIterationInstance) - */ - @Override - public void visit(IIterationInstance iterationInstance) { - visit((ITaskInstanceList) iterationInstance); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit( + * IIterationInstance) + */ + @Override + public void visit(IIterationInstance iterationInstance) { + visit((ITaskInstanceList) iterationInstance); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit(IOptionalInstance) - */ - @Override - public void visit(IOptionalInstance optionalInstance) { - if (optionalInstance.getChild() != null) { - optionalInstance.getChild().accept(this); - } - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit( + * IOptionalInstance) + */ + @Override + public void visit(IOptionalInstance optionalInstance) { + if (optionalInstance.getChild() != null) { + optionalInstance.getChild().accept(this); + } + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit(ISelectionInstance) - */ - @Override - public void visit(ISelectionInstance selectionInstance) { - selectionInstance.getChild().accept(this); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit( + * ISelectionInstance) + */ + @Override + public void visit(ISelectionInstance selectionInstance) { + selectionInstance.getChild().accept(this); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit(ISequenceInstance) - */ - @Override - public void visit(ISequenceInstance sequenceInstance) { - visit((ITaskInstanceList) sequenceInstance); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit( + * ISequenceInstance) + */ + @Override + public void visit(ISequenceInstance sequenceInstance) { + visit((ITaskInstanceList) sequenceInstance); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit(ITaskInstance) - */ - @Override - public void visit(ITaskInstance taskInstance) { - if (taskInstance instanceof IEventTaskInstance) { - visit((IEventTaskInstance) taskInstance); - } - else if (taskInstance instanceof IIterationInstance) { - visit((IIterationInstance) taskInstance); - } - else if (taskInstance instanceof IOptionalInstance) { - visit((IOptionalInstance) taskInstance); - } - else if (taskInstance instanceof ISelectionInstance) { - visit((ISelectionInstance) taskInstance); - } - else if (taskInstance instanceof ISequenceInstance) { - visit((ISequenceInstance) taskInstance); - } - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceVisitor#visit( + * ITaskInstance) + */ + @Override + public void visit(ITaskInstance taskInstance) { + if (taskInstance instanceof IEventTaskInstance) { + visit((IEventTaskInstance) taskInstance); + } else if (taskInstance instanceof IIterationInstance) { + visit((IIterationInstance) taskInstance); + } else if (taskInstance instanceof IOptionalInstance) { + visit((IOptionalInstance) taskInstance); + } else if (taskInstance instanceof ISelectionInstance) { + visit((ISelectionInstance) taskInstance); + } else if (taskInstance instanceof ISequenceInstance) { + visit((ISequenceInstance) taskInstance); + } + } - - /** - *

- * common implementation for traversing task instance lists. - *

- * - * @param taskInstanceList the task instance list to be traversed - */ - public void visit(ITaskInstanceList taskInstanceList) { - for (ITaskInstance child : taskInstanceList) { - child.accept(this); - } - } + /** + *

+ * common implementation for traversing task instance lists. + *

+ * + * @param taskInstanceList + * the task instance list to be traversed + */ + public void visit(ITaskInstanceList taskInstanceList) { + for (final ITaskInstance child : taskInstanceList) { + child.accept(this); + } + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/DefaultTaskTraversingVisitor.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/DefaultTaskTraversingVisitor.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/DefaultTaskTraversingVisitor.java (revision 1733) @@ -24,90 +24,103 @@ public class DefaultTaskTraversingVisitor implements ITaskVisitor { - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(IEventTask) - */ - @Override - public void visit(IEventTask eventTask) { - // do nothing - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(IEventTask) + */ + @Override + public void visit(IEventTask eventTask) { + // do nothing + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(IIteration) - */ - @Override - public void visit(IIteration iteration) { - visit((IMarkingTemporalRelationship) iteration); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(IIteration) + */ + @Override + public void visit(IIteration iteration) { + visit((IMarkingTemporalRelationship) iteration); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(IOptional) - */ - @Override - public void visit(IOptional optional) { - visit((IMarkingTemporalRelationship) optional); - } + /** + *

+ * common implementation for traversing a marking temporal relationship + *

+ * + * @param relationship + * the marking temporal relationship to be traversed + */ + public void visit(IMarkingTemporalRelationship relationship) { + if (relationship.getMarkedTask() != null) { + relationship.getMarkedTask().accept(this); + } + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(ISelection) - */ - @Override - public void visit(ISelection selection) { - visit((IStructuringTemporalRelationship) selection); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(IOptional) + */ + @Override + public void visit(IOptional optional) { + visit((IMarkingTemporalRelationship) optional); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(ISequence) - */ - @Override - public void visit(ISequence sequence) { - visit((IStructuringTemporalRelationship) sequence); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(ISelection) + */ + @Override + public void visit(ISelection selection) { + visit((IStructuringTemporalRelationship) selection); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(ITask) - */ - @Override - public void visit(ITask task) { - if (task instanceof IEventTask) { - visit((IEventTask) task); - } - else if (task instanceof IIteration) { - visit((IIteration) task); - } - else if (task instanceof IOptional) { - visit((IOptional) task); - } - else if (task instanceof ISelection) { - visit((ISelection) task); - } - else if (task instanceof ISequence) { - visit((ISequence) task); - } - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(ISequence) + */ + @Override + public void visit(ISequence sequence) { + visit((IStructuringTemporalRelationship) sequence); + } - /** - *

- * common implementation for traversing a structuring temporal relationship - *

- * - * @param relationship the structuring temporal relationship to be traversed - */ - public void visit(IStructuringTemporalRelationship relationship) { - for (ITask child : relationship.getChildren()) { - child.accept(this); - } - } + /** + *

+ * common implementation for traversing a structuring temporal relationship + *

+ * + * @param relationship + * the structuring temporal relationship to be traversed + */ + public void visit(IStructuringTemporalRelationship relationship) { + for (final ITask child : relationship.getChildren()) { + child.accept(this); + } + } - /** - *

- * common implementation for traversing a marking temporal relationship - *

- * - * @param relationship the marking temporal relationship to be traversed - */ - public void visit(IMarkingTemporalRelationship relationship) { - if (relationship.getMarkedTask() != null) { - relationship.getMarkedTask().accept(this); - } - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor#visit(ITask) + */ + @Override + public void visit(ITask task) { + if (task instanceof IEventTask) { + visit((IEventTask) task); + } else if (task instanceof IIteration) { + visit((IIteration) task); + } else if (task instanceof IOptional) { + visit((IOptional) task); + } else if (task instanceof ISelection) { + visit((ISelection) task); + } else if (task instanceof ISequence) { + visit((ISequence) task); + } + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IEventTask.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IEventTask.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IEventTask.java (revision 1733) @@ -17,9 +17,10 @@ /** *

- * Event tasks represent single events. They have no children and are therefore the leaf nodes of - * a task model. They provide information about the event they represent as a String description. - * They do not refer to events, as they may represented several semantically equal but lexically - * different events. Their description carries as much information as required to show the - * level of distinction. + * Event tasks represent single events. They have no children and are therefore + * the leaf nodes of a task model. They provide information about the event they + * represent as a String description. They do not refer to events, as they may + * represented several semantically equal but lexically different events. Their + * description carries as much information as required to show the level of + * distinction. *

* @@ -27,14 +28,15 @@ */ public interface IEventTask extends ITask { - - /** - *

- * returns a clone of this task, i.e. another event task being identical to this. The event - * type and target are not cloned but reused. - *

- * - * @return as described - */ - public IEventTask clone(); + + /** + *

+ * returns a clone of this task, i.e. another event task being identical to + * this. The event type and target are not cloned but reused. + *

+ * + * @return as described + */ + @Override + public IEventTask clone(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IEventTaskInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IEventTaskInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IEventTaskInstance.java (revision 1733) @@ -19,5 +19,6 @@ /** *

- * the instance of an {@link IEventTask}. The instance refers to the concrete event it represents. + * the instance of an {@link IEventTask}. The instance refers to the concrete + * event it represents. *

* @@ -26,31 +27,32 @@ public interface IEventTaskInstance extends ITaskInstance { - /** - *

- * returns the event represented by this event task instance - *

- * - * @return as described - */ - public Event getEvent(); + /** + *

+ * clones this task instance by creating exact clones of itself. The + * referred task and event stay untouched + *

+ * + * @return a clone of the task instance + */ + @Override + public IEventTaskInstance clone(); - /** - *

- * returns the task related to the instance, i.e. the event task. - *

- * - * @return as described - */ - public IEventTask getEventTask(); + /** + *

+ * returns the event represented by this event task instance + *

+ * + * @return as described + */ + public Event getEvent(); - /** - *

- * clones this task instance by creating exact clones of itself. The referred task and event - * stay untouched - *

- * - * @return a clone of the task instance - */ - public IEventTaskInstance clone(); - + /** + *

+ * returns the task related to the instance, i.e. the event task. + *

+ * + * @return as described + */ + public IEventTask getEventTask(); + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIteration.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIteration.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIteration.java (revision 1733) @@ -17,7 +17,8 @@ /** *

- * This temporal relationship defines that its single child may be executed zero or more times for - * fulfilling the task. This is most important for the parent node in the task model as this - * node may require that a specific subtask is executed several times. + * This temporal relationship defines that its single child may be executed zero + * or more times for fulfilling the task. This is most important for the parent + * node in the task model as this node may require that a specific subtask is + * executed several times. *

* @@ -26,14 +27,16 @@ public interface IIteration extends IMarkingTemporalRelationship { - /** - *

- * returns an exact copy of this temporal relationship. The clone has the same id. Its child - * is a clone of the child of the cloned task. A call on the method {@link #equals(ITask)} - * with the result of this method must return true. - *

- * - * @return as described - */ - public IIteration clone(); + /** + *

+ * returns an exact copy of this temporal relationship. The clone has the + * same id. Its child is a clone of the child of the cloned task. A call on + * the method {@link #equals(ITask)} with the result of this method must + * return true. + *

+ * + * @return as described + */ + @Override + public IIteration clone(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIterationInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIterationInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IIterationInstance.java (revision 1733) @@ -17,6 +17,7 @@ /** *

- * the instance of an {@link IIteration}. The instance may have several children each being an - * instance of the task marked by the iteration of which this is an instance. + * the instance of an {@link IIteration}. The instance may have several children + * each being an instance of the task marked by the iteration of which this is + * an instance. *

* @@ -25,22 +26,23 @@ public interface IIterationInstance extends ITaskInstance, ITaskInstanceList { - /** - *

- * returns the task related to the instance, i.e. the iteration. - *

- * - * @return as described - */ - public IIteration getIteration(); + /** + *

+ * clones this task instance by creating exact clones of each contained + * instance in their order + *

+ * + * @return a clone of the task instance list + */ + @Override + public IIterationInstance clone(); - /** - *

- * clones this task instance by creating exact clones of each contained instance in their - * order - *

- * - * @return a clone of the task instance list - */ - public IIterationInstance clone(); + /** + *

+ * returns the task related to the instance, i.e. the iteration. + *

+ * + * @return as described + */ + public IIteration getIteration(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IMarkingTemporalRelationship.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IMarkingTemporalRelationship.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IMarkingTemporalRelationship.java (revision 1733) @@ -17,6 +17,7 @@ /** *

- * A marking temporal relationship defines a temporal information for exactly one node in the task - * model. I.e., it has only one child for which it defines a special execution characteristic. + * A marking temporal relationship defines a temporal information for exactly + * one node in the task model. I.e., it has only one child for which it defines + * a special execution characteristic. *

* @@ -25,24 +26,26 @@ public interface IMarkingTemporalRelationship extends ITemporalRelationship { - /** - *

- * returns the task for which this relationship defines the execution characteristic. The - * task can be seen as the child node of this node. - *

- * - * @return as described - */ - public ITask getMarkedTask(); + /** + *

+ * returns an exact copy of this temporal relationship. The clone has the + * same id. Its child is a clone of the child of the cloned task. A call on + * the method {@link #equals(ITask)} with the result of this method must + * return true. + *

+ * + * @return as described + */ + @Override + public IMarkingTemporalRelationship clone(); - /** - *

- * returns an exact copy of this temporal relationship. The clone has the same id. Its child - * is a clone of the child of the cloned task. A call on the method {@link #equals(ITask)} - * with the result of this method must return true. - *

- * - * @return as described - */ - public IMarkingTemporalRelationship clone(); + /** + *

+ * returns the task for which this relationship defines the execution + * characteristic. The task can be seen as the child node of this node. + *

+ * + * @return as described + */ + public ITask getMarkedTask(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptional.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptional.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptional.java (revision 1733) @@ -17,7 +17,8 @@ /** *

- * This temporal relationship defines that its single child may or may not be executed for - * fulfilling the task. This is most important for the parent node in the task model as this - * node may require that a specific subtask is optional. + * This temporal relationship defines that its single child may or may not be + * executed for fulfilling the task. This is most important for the parent node + * in the task model as this node may require that a specific subtask is + * optional. *

* @@ -26,14 +27,16 @@ public interface IOptional extends IMarkingTemporalRelationship { - /** - *

- * returns an exact copy of this temporal relationship. The clone has the same id. Its child - * is a clone of the child of the cloned task. A call on the method {@link #equals(ITask)} - * with the result of this method must return true. - *

- * - * @return as described - */ - public IOptional clone(); + /** + *

+ * returns an exact copy of this temporal relationship. The clone has the + * same id. Its child is a clone of the child of the cloned task. A call on + * the method {@link #equals(ITask)} with the result of this method must + * return true. + *

+ * + * @return as described + */ + @Override + public IOptional clone(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptionalInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptionalInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IOptionalInstance.java (revision 1733) @@ -18,6 +18,7 @@ *

* the instance of an {@link IOptional}. The instance may have a child being an - * instance of the task marked by the optional of which this is an instance. If this instance - * does not have a child, the optional child task was not executed. + * instance of the task marked by the optional of which this is an instance. If + * this instance does not have a child, the optional child task was not + * executed. *

* @@ -26,30 +27,33 @@ public interface IOptionalInstance extends ITaskInstance { - /** - *

- * returns the child of the optional of null if the optional was not executed - *

- * - * @return as described - */ - public ITaskInstance getChild(); + /** + *

+ * clones this task instance by creating exact clones of each contained + * instance + *

+ * + * @return a clone of the task instance + */ + @Override + public IOptionalInstance clone(); - /** - *

- * returns the task related to the instance, i.e. the optional. - *

- * - * @return as described - */ - public IOptional getOptional(); + /** + *

+ * returns the child of the optional of null if the optional was not + * executed + *

+ * + * @return as described + */ + public ITaskInstance getChild(); - /** - *

- * clones this task instance by creating exact clones of each contained instance - *

- * - * @return a clone of the task instance - */ - public IOptionalInstance clone(); + /** + *

+ * returns the task related to the instance, i.e. the optional. + *

+ * + * @return as described + */ + public IOptional getOptional(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelection.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelection.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelection.java (revision 1733) @@ -17,6 +17,6 @@ /** *

- * This temporal relationship defines that only one of its children must be executed for - * fulfilling the represented task. + * This temporal relationship defines that only one of its children must be + * executed for fulfilling the represented task. *

* @@ -25,14 +25,16 @@ public interface ISelection extends IStructuringTemporalRelationship { - /** - *

- * returns an exact copy of this temporal relationship. The clone has the same id. Its children - * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} - * with the result of this method must return true. - *

- * - * @return as described - */ - public ISelection clone(); + /** + *

+ * returns an exact copy of this temporal relationship. The clone has the + * same id. Its children are clones of the children of the cloned task. A + * call on the method {@link #equals(ITask)} with the result of this method + * must return true. + *

+ * + * @return as described + */ + @Override + public ISelection clone(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelectionInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelectionInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISelectionInstance.java (revision 1733) @@ -17,6 +17,6 @@ /** *

- * the instance of an {@link ISelection}. The instance has a child being an instance of the child - * task of the selection that was selected for execution. + * the instance of an {@link ISelection}. The instance has a child being an + * instance of the child task of the selection that was selected for execution. *

* @@ -25,30 +25,32 @@ public interface ISelectionInstance extends ITaskInstance { - /** - *

- * returns the selected child of the selection - *

- * - * @return as described - */ - public ITaskInstance getChild(); + /** + *

+ * clones this task instance by creating exact clones of the contained + * instance + *

+ * + * @return a clone of the task instance + */ + @Override + public ISelectionInstance clone(); - /** - *

- * returns the task related to the instance, i.e. the selection. - *

- * - * @return as described - */ - public ISelection getSelection(); + /** + *

+ * returns the selected child of the selection + *

+ * + * @return as described + */ + public ITaskInstance getChild(); - /** - *

- * clones this task instance by creating exact clones of the contained instance - *

- * - * @return a clone of the task instance - */ - public ISelectionInstance clone(); + /** + *

+ * returns the task related to the instance, i.e. the selection. + *

+ * + * @return as described + */ + public ISelection getSelection(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequence.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequence.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequence.java (revision 1733) @@ -17,6 +17,6 @@ /** *

- * This temporal relationship defines that its children must be executed in the order they are - * listed for fulfilling the represented task. + * This temporal relationship defines that its children must be executed in the + * order they are listed for fulfilling the represented task. *

* @@ -25,14 +25,16 @@ public interface ISequence extends IStructuringTemporalRelationship { - /** - *

- * returns an exact copy of this temporal relationship. The clone has the same id. Its children - * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} - * with the result of this method must return true. - *

- * - * @return as described - */ - public ISequence clone(); + /** + *

+ * returns an exact copy of this temporal relationship. The clone has the + * same id. Its children are clones of the children of the cloned task. A + * call on the method {@link #equals(ITask)} with the result of this method + * must return true. + *

+ * + * @return as described + */ + @Override + public ISequence clone(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequenceInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequenceInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ISequenceInstance.java (revision 1733) @@ -17,6 +17,6 @@ /** *

- * the instance of an {@link ISequence}. The instance has the same number of children as the - * sequence it represents. + * the instance of an {@link ISequence}. The instance has the same number of + * children as the sequence it represents. *

* @@ -25,22 +25,23 @@ public interface ISequenceInstance extends ITaskInstance, ITaskInstanceList { - /** - *

- * returns the task related to the instance, i.e. the sequence. - *

- * - * @return as described - */ - public ISequence getSequence(); + /** + *

+ * clones this task instance by creating exact clones of each contained + * instance in their order + *

+ * + * @return a clone of the task instance + */ + @Override + public ISequenceInstance clone(); - /** - *

- * clones this task instance by creating exact clones of each contained instance in their - * order - *

- * - * @return a clone of the task instance - */ - public ISequenceInstance clone(); - + /** + *

+ * returns the task related to the instance, i.e. the sequence. + *

+ * + * @return as described + */ + public ISequence getSequence(); + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IStructuringTemporalRelationship.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IStructuringTemporalRelationship.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IStructuringTemporalRelationship.java (revision 1733) @@ -19,6 +19,7 @@ /** *

- * A structuring temporal relationship defines a temporal information for several nodes in the task - * model. I.e., it has several children and defines an execution order for them. + * A structuring temporal relationship defines a temporal information for + * several nodes in the task model. I.e., it has several children and defines an + * execution order for them. *

* @@ -27,23 +28,25 @@ public interface IStructuringTemporalRelationship extends ITemporalRelationship { - /** - *

- * returns the children of this temporal relationship. - *

- * - * @return as described - */ - public List getChildren(); + /** + *

+ * returns an exact copy of this temporal relationship. The clone has the + * same id. Its children are clones of the children of the cloned task. A + * call on the method {@link #equals(ITask)} with the result of this method + * must return true. + *

+ * + * @return as described + */ + @Override + public IStructuringTemporalRelationship clone(); - /** - *

- * returns an exact copy of this temporal relationship. The clone has the same id. Its children - * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} - * with the result of this method must return true. - *

- * - * @return as described - */ - public IStructuringTemporalRelationship clone(); + /** + *

+ * returns the children of this temporal relationship. + *

+ * + * @return as described + */ + public List getChildren(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITask.java (revision 1733) @@ -20,10 +20,12 @@ /** *

- * A task represents a model for events that occur if the user interacts with a software for - * achieving a specific goal. A task can be a single event or a complex structure of events - * and temporal relationships defining the event order. Tasks may especially refer to other tasks - * to create task structures similar to trees. These structures fully define in which ways the - * events that form the task can occur. However, the structure of a task is not necessarily a - * tree as task structures may be reused several times in larger scale task structures. + * A task represents a model for events that occur if the user interacts with a + * software for achieving a specific goal. A task can be a single event or a + * complex structure of events and temporal relationships defining the event + * order. Tasks may especially refer to other tasks to create task structures + * similar to trees. These structures fully define in which ways the events that + * form the task can occur. However, the structure of a task is not necessarily + * a tree as task structures may be reused several times in larger scale task + * structures. *

* @@ -32,90 +34,96 @@ public interface ITask extends Cloneable, Serializable { - /** - *

- * every task is assigned a unique id which is returned by this method. The id is unique for - * the current runtime. - *

- * - * @return as described - */ - public int getId(); + /** + *

+ * implements the visitor pattern to be able to process tasks and their + * children. + *

+ * + * @param visitor + * the visitor used to process the task + */ + public void accept(ITaskVisitor visitor); - /** - *

- * returns a human readable type for the task. - *

- * - * @return as described - */ - public String getType(); + /** + *

+ * returns an exact copy of this task. The clone has the same id. If the + * task has children, they are cloned as well. A call on the method + * {@link #equals(ITask)} with the result of this method must return true. + *

+ * + * @return as described + */ + public ITask clone(); - /** - *

- * returns a human readable description for the task. - *

- * - * @return as described - */ - public String getDescription(); + /** + *

+ * checks whether this task is equal to another one. Task equality is only + * given, if two tasks have the same id. This means, that this method must + * only return true if the other task is either the same object or a clone + * of it. + *

+ * + * @return as described + */ + public boolean equals(ITask task); - /** - *

- * returns a collection of all observed instances of this task - *

- * - * @return as described - */ - public Collection getInstances(); + /** + *

+ * returns a human readable description for the task. + *

+ * + * @return as described + */ + public String getDescription(); - /** - *

- * returns a collection of collections of all different execution variants of this task. This - * is a grouping of all instances where each group contains structurally identical instances. - *

- * - * @return as described - */ - public Collection> getExecutionVariants(); + /** + *

+ * returns a collection of collections of all different execution variants + * of this task. This is a grouping of all instances where each group + * contains structurally identical instances. + *

+ * + * @return as described + */ + public Collection> getExecutionVariants(); - /** - *

- * checks whether this task is equal to another one. Task equality is only given, if two - * tasks have the same id. This means, that this method must only return true if the other - * task is either the same object or a clone of it. - *

- * - * @return as described - */ - public boolean equals(ITask task); + /** + *

+ * every task is assigned a unique id which is returned by this method. The + * id is unique for the current runtime. + *

+ * + * @return as described + */ + public int getId(); - /** - *

- * returns a hash code for the task, which is usually the id returned by {@link #getId()}. - *

- * - * @return as described - */ - public int hashCode(); + /** + *

+ * returns a collection of all observed instances of this task + *

+ * + * @return as described + */ + public Collection getInstances(); - /** - *

- * returns an exact copy of this task. The clone has the same id. If the task has - * children, they are cloned as well. A call on the method {@link #equals(ITask)} with the - * result of this method must return true. - *

- * - * @return as described - */ - public ITask clone(); - - /** - *

- * implements the visitor pattern to be able to process tasks and their children. - *

- * - * @param visitor the visitor used to process the task - */ - public void accept(ITaskVisitor visitor); - + /** + *

+ * returns a human readable type for the task. + *

+ * + * @return as described + */ + public String getType(); + + /** + *

+ * returns a hash code for the task, which is usually the id returned by + * {@link #getId()}. + *

+ * + * @return as described + */ + @Override + public int hashCode(); + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskBuilder.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskBuilder.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskBuilder.java (revision 1733) @@ -17,243 +17,303 @@ /** *

- * Builder for task models. Can be used to create and edit task models. May perform integrity - * checks, though they may be incomplete as the integrity of a task model can not be ensured during - * creation. + * Builder for task models. Can be used to create and edit task models. May + * perform integrity checks, though they may be incomplete as the integrity of a + * task model can not be ensured during creation. *

*/ public interface ITaskBuilder { - /** - *

- * adds a child to a sequence instance. May ensure, that the child is a valid child considering - * the task model of the parent. In that case, an IllegalArgumentException is thrown. - *

- * - * @param instance the instance of add the child to - * @param child the child to be added - * - * @throws IllegalArgumentException as described - */ - void addChild(ISequenceInstance instance, ITaskInstance child) throws IllegalArgumentException; - - /** - *

- * adds a child to an iteration instance. May ensure, that the child is a valid child - * considering the task model of the parent. In that case, an IllegalArgumentException is - * thrown. - *

- * - * @param instance the instance of add the child to - * @param child the child to be added - * - * @throws IllegalArgumentException as described - */ - void addChild(IIterationInstance instance, ITaskInstance child) throws IllegalArgumentException; - - /** - *

- * sets the child of a selection instance. May ensure, that the child is a valid child - * considering the task model of the parent. In that case, an IllegalArgumentException is - * thrown. - *

- * - * @param instance the instance of add the child to - * @param child the child to be added - * - * @throws IllegalArgumentException as described - */ - void setChild(ISelectionInstance instance, ITaskInstance child) throws IllegalArgumentException; - - /** - *

- * sets the child of an optional instance. May ensure, that the child is a valid child - * considering the task model of the parent. In that case, an IllegalArgumentException is - * thrown. - *

- * - * @param instance the instance of add the child to - * @param child the child to be added - * - * @throws IllegalArgumentException as described - */ - void setChild(IOptionalInstance instance, ITaskInstance child) throws IllegalArgumentException; - - /** - *

- * adds a task instance to a user session - *

- * - * @param session the session to add the task instance to - * @param taskInstance the task instance to add - */ - void addExecutedTask(IUserSession session, ITaskInstance taskInstance); - - /** - *

- * adds a task instance to a task instance list - *

- * - * @param taskInstanceList the list to add the task instance to - * @param taskInstance the task instance to add - */ - void addTaskInstance(ITaskInstanceList taskInstanceList, ITaskInstance taskInstance); - - /** - *

- * adds a task instance to a task instance list at a specific position. Subsequent task - * instances will be moved one index forward - *

- * - * @param taskInstanceList the list to add the task instance to - * @param index the index of the task instance to add - * @param taskInstance the task instance to add - * - * @throws IndexOutOfBoundsException if the index is invalid - */ - void addTaskInstance(ITaskInstanceList taskInstanceList, int index, ITaskInstance taskInstance) - throws IndexOutOfBoundsException; - - /** - *

- * sets a task instance in a task instance list at a specific position - *

- * - * @param taskInstanceList the list to set the task instance in - * @param index the index of the task instance to replace - * @param taskInstance the replacement for the task instance at the index - * - * @throws IndexOutOfBoundsException if the index is invalid - */ - void setTaskInstance(ITaskInstanceList taskInstanceList, int index, ITaskInstance taskInstance) - throws IndexOutOfBoundsException; - - /** - *

- * sets the task model of a task instance - *

- * - * @param taskInstance the task instance to set the task model for - * @param task the task model of the instance - */ - void setTask(ITaskInstance taskInstance, ITask task); - - /** - *

- * adds a child task to the end of a sequence - *

- * - * @param parent the sequence to add the child to - * @param child the child to be added - */ - void addChild(ISequence parent, ITask child); - - /** - *

- * adds a child task to a specific index of a sequence - *

- * - * @param parent the sequence to add the child to - * @param index the index to set the child at - * @param child the child to be added - * - * @throws IndexOutOfBoundsException if the index is invalid - */ - void addChild(ISequence parent, int index, ITask child) - throws IndexOutOfBoundsException; - - /** - *

- * replaces the child task of a sequence at a specific position - *

- * - * @param parent the sequence to replace the child in - * @param index the index to replace the child at - * @param child the child to be added - * - * @throws IndexOutOfBoundsException if the index is invalid - */ - void setChild(ISequence parent, int index, ITask child) - throws IndexOutOfBoundsException; - - /** - *

- * adds a child task to a selection - *

- * - * @param parent the selection to add the child to - * @param child the child to be added - */ - void addChild(ISelection parent, ITask child); - - /** - *

- * sets the child task of an iteration - *

- * - * @param iteration the iteration to set the child of - * @param child the child to be set - */ - void setMarkedTask(IIteration iteration, ITask child); - - /** - *

- * sets the child task of an optional - *

- * - * @param optional the optional to set the child of - * @param child the child to be set - */ - void setMarkedTask(IOptional optional, ITask child); - - /** - *

- * removes the child of a sequence at a specific position - *

- * - * @param parent the sequence of which the child must be removed - * @param index the index of the child to be removed - * - * @throws IndexOutOfBoundsException if the index is invalid - */ - void removeChild(ISequence parent, int index) - throws IndexOutOfBoundsException; - - /** - *

- * removes a child of a selection. Ignores the call, if the child is not found - * (comparison using equals). - *

- * - * @param parent the selection of which the child must be removed - * @param child the child to be removes - */ - void removeChild(ISelection parent, ITask child); - - /** - *

- * removes the entry of a task instance list at a specific position - *

- * - * @param taskInstanceList the task instance list of which the entry must be removed - * @param index the index of the entry to be removed - * - * @throws IndexOutOfBoundsException if the index is invalid - */ - void removeTaskInstance(ITaskInstanceList taskInstanceList, int index) - throws IndexOutOfBoundsException; - - /** - *

- * replaces a child of a selection. Throws an IllegalArgumentException if the child is not - * found (comparison using equals). - *

- * - * @param parent the selection of which the child must be replace - * @param oldChild the child to replace - * @param newChild the replacement for the child - * - * @throws as described - */ - void replaceChild(ISelection parent, ITask oldChild, ITask newChild); + /** + *

+ * adds a child to an iteration instance. May ensure, that the child is a + * valid child considering the task model of the parent. In that case, an + * IllegalArgumentException is thrown. + *

+ * + * @param instance + * the instance of add the child to + * @param child + * the child to be added + * + * @throws IllegalArgumentException + * as described + */ + void addChild(IIterationInstance instance, ITaskInstance child) + throws IllegalArgumentException; + + /** + *

+ * adds a child task to a selection + *

+ * + * @param parent + * the selection to add the child to + * @param child + * the child to be added + */ + void addChild(ISelection parent, ITask child); + + /** + *

+ * adds a child task to a specific index of a sequence + *

+ * + * @param parent + * the sequence to add the child to + * @param index + * the index to set the child at + * @param child + * the child to be added + * + * @throws IndexOutOfBoundsException + * if the index is invalid + */ + void addChild(ISequence parent, int index, ITask child) + throws IndexOutOfBoundsException; + + /** + *

+ * adds a child task to the end of a sequence + *

+ * + * @param parent + * the sequence to add the child to + * @param child + * the child to be added + */ + void addChild(ISequence parent, ITask child); + + /** + *

+ * adds a child to a sequence instance. May ensure, that the child is a + * valid child considering the task model of the parent. In that case, an + * IllegalArgumentException is thrown. + *

+ * + * @param instance + * the instance of add the child to + * @param child + * the child to be added + * + * @throws IllegalArgumentException + * as described + */ + void addChild(ISequenceInstance instance, ITaskInstance child) + throws IllegalArgumentException; + + /** + *

+ * adds a task instance to a user session + *

+ * + * @param session + * the session to add the task instance to + * @param taskInstance + * the task instance to add + */ + void addExecutedTask(IUserSession session, ITaskInstance taskInstance); + + /** + *

+ * adds a task instance to a task instance list at a specific position. + * Subsequent task instances will be moved one index forward + *

+ * + * @param taskInstanceList + * the list to add the task instance to + * @param index + * the index of the task instance to add + * @param taskInstance + * the task instance to add + * + * @throws IndexOutOfBoundsException + * if the index is invalid + */ + void addTaskInstance(ITaskInstanceList taskInstanceList, int index, + ITaskInstance taskInstance) throws IndexOutOfBoundsException; + + /** + *

+ * adds a task instance to a task instance list + *

+ * + * @param taskInstanceList + * the list to add the task instance to + * @param taskInstance + * the task instance to add + */ + void addTaskInstance(ITaskInstanceList taskInstanceList, + ITaskInstance taskInstance); + + /** + *

+ * removes a child of a selection. Ignores the call, if the child is not + * found (comparison using equals). + *

+ * + * @param parent + * the selection of which the child must be removed + * @param child + * the child to be removes + */ + void removeChild(ISelection parent, ITask child); + + /** + *

+ * removes the child of a sequence at a specific position + *

+ * + * @param parent + * the sequence of which the child must be removed + * @param index + * the index of the child to be removed + * + * @throws IndexOutOfBoundsException + * if the index is invalid + */ + void removeChild(ISequence parent, int index) + throws IndexOutOfBoundsException; + + /** + *

+ * removes the entry of a task instance list at a specific position + *

+ * + * @param taskInstanceList + * the task instance list of which the entry must be removed + * @param index + * the index of the entry to be removed + * + * @throws IndexOutOfBoundsException + * if the index is invalid + */ + void removeTaskInstance(ITaskInstanceList taskInstanceList, int index) + throws IndexOutOfBoundsException; + + /** + *

+ * replaces a child of a selection. Throws an IllegalArgumentException if + * the child is not found (comparison using equals). + *

+ * + * @param parent + * the selection of which the child must be replace + * @param oldChild + * the child to replace + * @param newChild + * the replacement for the child + * + * @throws as + * described + */ + void replaceChild(ISelection parent, ITask oldChild, ITask newChild); + + /** + *

+ * sets the child of an optional instance. May ensure, that the child is a + * valid child considering the task model of the parent. In that case, an + * IllegalArgumentException is thrown. + *

+ * + * @param instance + * the instance of add the child to + * @param child + * the child to be added + * + * @throws IllegalArgumentException + * as described + */ + void setChild(IOptionalInstance instance, ITaskInstance child) + throws IllegalArgumentException; + + /** + *

+ * sets the child of a selection instance. May ensure, that the child is a + * valid child considering the task model of the parent. In that case, an + * IllegalArgumentException is thrown. + *

+ * + * @param instance + * the instance of add the child to + * @param child + * the child to be added + * + * @throws IllegalArgumentException + * as described + */ + void setChild(ISelectionInstance instance, ITaskInstance child) + throws IllegalArgumentException; + + /** + *

+ * replaces the child task of a sequence at a specific position + *

+ * + * @param parent + * the sequence to replace the child in + * @param index + * the index to replace the child at + * @param child + * the child to be added + * + * @throws IndexOutOfBoundsException + * if the index is invalid + */ + void setChild(ISequence parent, int index, ITask child) + throws IndexOutOfBoundsException; + + /** + *

+ * sets the child task of an iteration + *

+ * + * @param iteration + * the iteration to set the child of + * @param child + * the child to be set + */ + void setMarkedTask(IIteration iteration, ITask child); + + /** + *

+ * sets the child task of an optional + *

+ * + * @param optional + * the optional to set the child of + * @param child + * the child to be set + */ + void setMarkedTask(IOptional optional, ITask child); + + /** + *

+ * sets the task model of a task instance + *

+ * + * @param taskInstance + * the task instance to set the task model for + * @param task + * the task model of the instance + */ + void setTask(ITaskInstance taskInstance, ITask task); + + /** + *

+ * sets a task instance in a task instance list at a specific position + *

+ * + * @param taskInstanceList + * the list to set the task instance in + * @param index + * the index of the task instance to replace + * @param taskInstance + * the replacement for the task instance at the index + * + * @throws IndexOutOfBoundsException + * if the index is invalid + */ + void setTaskInstance(ITaskInstanceList taskInstanceList, int index, + ITaskInstance taskInstance) throws IndexOutOfBoundsException; } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskFactory.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskFactory.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskFactory.java (revision 1733) @@ -28,126 +28,135 @@ public interface ITaskFactory { - /** - *

- * creates a new event task with the given description - *

- * - * @param description the description for the represented events - * - * @return the event task - */ - IEventTask createNewEventTask(String description); + /** + *

+ * creates a new event task with the given description + *

+ * + * @param description + * the description for the represented events + * + * @return the event task + */ + IEventTask createNewEventTask(String description); - /** - *

- * creates a new empty sequence - *

- * - * @return the sequence - */ - ISequence createNewSequence(); + /** + *

+ * creates a new empty iteration + *

+ * + * @return the iteration + */ + IIteration createNewIteration(); - /** - *

- * creates a new empty iteration - *

- * - * @return the iteration - */ - IIteration createNewIteration(); + /** + *

+ * creates a new empty optional + *

+ * + * @return the optional + */ + IOptional createNewOptional(); - /** - *

- * creates a new empty optional - *

- * - * @return the optional - */ - IOptional createNewOptional(); + /** + *

+ * creates a new empty selection + *

+ * + * @return the selection + */ + ISelection createNewSelection(); - /** - *

- * creates a new empty selection - *

- * - * @return the selection - */ - ISelection createNewSelection(); + /** + *

+ * creates a new empty sequence + *

+ * + * @return the sequence + */ + ISequence createNewSequence(); - /** - *

- * creates a new task instance with the given task as its model representing the provided event - *

- * - * @param task the model of the task instance to be created - * @param event the event represented by the task instance - * - * @return the task instance - */ - IEventTaskInstance createNewTaskInstance(IEventTask task, Event event); + /** + *

+ * creates a new task instance with the given task as its model representing + * the provided event + *

+ * + * @param task + * the model of the task instance to be created + * @param event + * the event represented by the task instance + * + * @return the task instance + */ + IEventTaskInstance createNewTaskInstance(IEventTask task, Event event); - /** - *

- * creates a new task instance with the given sequence as its model - *

- * - * @param sequence the model of the task instance to be created - * - * @return the task instance - */ - ISequenceInstance createNewTaskInstance(ISequence sequence); + /** + *

+ * creates a new task instance with the given iteration as its model + *

+ * + * @param iteration + * the model of the task instance to be created + * + * @return the task instance + */ + IIterationInstance createNewTaskInstance(IIteration iteration); - /** - *

- * creates a new task instance with the given iteration as its model - *

- * - * @param iteration the model of the task instance to be created - * - * @return the task instance - */ - IIterationInstance createNewTaskInstance(IIteration iteration); + /** + *

+ * creates a new task instance with the given optional as its model + *

+ * + * @param optional + * the model of the task instance to be created + * + * @return the task instance + */ + IOptionalInstance createNewTaskInstance(IOptional optional); - /** - *

- * creates a new task instance with the given optional as its model - *

- * - * @param optional the model of the task instance to be created - * - * @return the task instance - */ - IOptionalInstance createNewTaskInstance(IOptional optional); + /** + *

+ * creates a new task instance with the given selection as its model + *

+ * + * @param selection + * the model of the task instance to be created + * + * @return the task instance + */ + ISelectionInstance createNewTaskInstance(ISelection selection); - /** - *

- * creates a new task instance with the given selection as its model - *

- * - * @param selection the model of the task instance to be created - * - * @return the task instance - */ - ISelectionInstance createNewTaskInstance(ISelection selection); + /** + *

+ * creates a new task instance with the given sequence as its model + *

+ * + * @param sequence + * the model of the task instance to be created + * + * @return the task instance + */ + ISequenceInstance createNewTaskInstance(ISequence sequence); - /** - *

- * creates a new empty user session - *

- * - * @return the user session - */ - IUserSession createUserSession(); + /** + *

+ * creates a task model based on the provided user sessions + *

+ * + * @param userSessions + * the session based on which the task model shall be created + * + * @return the task model + */ + ITaskModel createTaskModel(List userSessions); - /** - *

- * creates a task model based on the provided user sessions - *

- * - * @param userSessions the session based on which the task model shall be created - * - * @return the task model - */ - ITaskModel createTaskModel(List userSessions); + /** + *

+ * creates a new empty user session + *

+ * + * @return the user session + */ + IUserSession createUserSession(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInfo.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInfo.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInfo.java (revision 1733) @@ -17,6 +17,7 @@ /** *

- * Provides extended information about a specific task, such as statistics about task occurrences, - * etc. It contains measures for different metrics determined for a task. + * Provides extended information about a specific task, such as statistics about + * task occurrences, etc. It contains measures for different metrics determined + * for a task. *

* @@ -25,85 +26,88 @@ public interface ITaskInfo { - /** - *

- * returns the task to which these infos belong - *

- * - * @return as described - */ - public ITask getTask(); + /** + *

+ * represents a measure for a specific metric + *

+ * + * @author Patrick Harms + */ + public interface IMeasure { - /** - *

- * returns all available measures - *

- * - * @return as described - */ - public IMeasure[] getMeasures(); + /** + *

+ * returns the metric of the measure + *

+ * + * @return as described + */ + public TaskMetric getMetric(); - /** - *

- * returns the value of the measure identified through the given metric - *

- * - * @param metric the metric for which the value is to be returned - * - * @return as described - */ - public int getMeasureValue(TaskMetric metric); + /** + *

+ * returns the value of the measure + *

+ * + * @return as described + */ + public int getValue(); - /** - *

- * returns the value of the measure identified through the given metric if the task is - * observed in the given context, i.e. parent task. The result is Integer.MIN_VALUE if there - * is no value for this measure in a context. - *

- * - * @param metric the metric for which the value is to be returned - * @param context the context for which the measure value is to be returned - * - * @return as described - */ - public int getMeasureValue(TaskMetric metric, ITask context); + /** + *

+ * returns the value of the measure if the task was observed in a + * specific context, i.e. parent task + *

+ * + * @return as described + */ + public int getValue(ITask context); - /** - *

- * represents a measure for a specific metric - *

- * - * @author Patrick Harms - */ - public interface IMeasure { - - /** - *

- * returns the metric of the measure - *

- * - * @return as described - */ - public TaskMetric getMetric(); - - /** - *

- * returns the value of the measure - *

- * - * @return as described - */ - public int getValue(); - - /** - *

- * returns the value of the measure if the task was observed in a specific context, i.e. - * parent task - *

- * - * @return as described - */ - public int getValue(ITask context); - - } + } + + /** + *

+ * returns all available measures + *

+ * + * @return as described + */ + public IMeasure[] getMeasures(); + + /** + *

+ * returns the value of the measure identified through the given metric + *

+ * + * @param metric + * the metric for which the value is to be returned + * + * @return as described + */ + public int getMeasureValue(TaskMetric metric); + + /** + *

+ * returns the value of the measure identified through the given metric if + * the task is observed in the given context, i.e. parent task. The result + * is Integer.MIN_VALUE if there is no value for this measure in a context. + *

+ * + * @param metric + * the metric for which the value is to be returned + * @param context + * the context for which the measure value is to be returned + * + * @return as described + */ + public int getMeasureValue(TaskMetric metric, ITask context); + + /** + *

+ * returns the task to which these infos belong + *

+ * + * @return as described + */ + public ITask getTask(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstance.java (revision 1733) @@ -19,6 +19,6 @@ /** *

- * a task instance represents the execution of a specific task within a user session. A task - * instance is always related to the task that was executed. + * a task instance represents the execution of a specific task within a user + * session. A task instance is always related to the task that was executed. *

* @@ -27,54 +27,59 @@ public interface ITaskInstance extends Serializable, Cloneable { - /** - *

- * returns the task related to the instance. - *

- * - * @return as described - */ - public ITask getTask(); + /** + *

+ * implements the visitor pattern to be able to process task instances and + * their children. + *

+ * + * @param visitor + * the visitor used to process the task + */ + public void accept(ITaskInstanceVisitor visitor); - /** - *

- * compares an instance to another one. Returns true if both instances are the same, i.e. not - * only the related task is equal but also all children and further characteristics of the - * task instance - *

- * - * @param taskInstance the instance to compare to - * - * @return as described - */ - public boolean equals(ITaskInstance taskInstance); + /** + *

+ * clones a task instance by creating exact clones of each contained child + * instance as well as the related task. Furthermore, all other non + * transient information of the task instance must be cloned. + *

+ * + * @return a clone of the task instance + */ + public ITaskInstance clone(); - /** - *

- * returns a hash code for the task instance to be able to put it into hash maps - *

- * - * @return as described - */ - public int hashCode(); + /** + *

+ * compares an instance to another one. Returns true if both instances are + * the same, i.e. not only the related task is equal but also all children + * and further characteristics of the task instance + *

+ * + * @param taskInstance + * the instance to compare to + * + * @return as described + */ + public boolean equals(ITaskInstance taskInstance); - /** - *

- * clones a task instance by creating exact clones of each contained child instance as well - * as the related task. Furthermore, all other non transient information of the task - * instance must be cloned. - *

- * - * @return a clone of the task instance - */ - public ITaskInstance clone(); + /** + *

+ * returns the task related to the instance. + *

+ * + * @return as described + */ + public ITask getTask(); - /** - *

- * implements the visitor pattern to be able to process task instances and their children. - *

- * - * @param visitor the visitor used to process the task - */ - public void accept(ITaskInstanceVisitor visitor); - + /** + *

+ * returns a hash code for the task instance to be able to put it into hash + * maps + *

+ * + * @return as described + */ + @Override + public int hashCode(); + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceList.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceList.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceList.java (revision 1733) @@ -19,32 +19,36 @@ /** *

- * represents a serializable and iterable representation of a read only list of task - * instances. The list is ordered. It does not provide methods for changing it. + * represents a serializable and iterable representation of a read only list of + * task instances. The list is ordered. It does not provide methods for changing + * it. *

* * @author Patrick Harms */ -public interface ITaskInstanceList extends Cloneable, Serializable, Iterable { +public interface ITaskInstanceList extends Cloneable, Serializable, + Iterable { - /** - *

- * returns the task instance at the position with the given index. May throw an exception - * if the index is invalid. - *

- * - * @param index the index of the task instance to be returned - * - * @return the task instance at the given index - */ - public ITaskInstance get(int index); + /** + *

+ * returns the task instance at the position with the given index. May throw + * an exception if the index is invalid. + *

+ * + * @param index + * the index of the task instance to be returned + * + * @return the task instance at the given index + */ + public ITaskInstance get(int index); - /** - *

- * returns the size of the list, i.e. the number of task instances in the list - *

- * - * @return as described - */ - public int size(); + /** + *

+ * returns the size of the list, i.e. the number of task instances in the + * list + *

+ * + * @return as described + */ + public int size(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceVisitor.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceVisitor.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskInstanceVisitor.java (revision 1733) @@ -15,9 +15,8 @@ package de.ugoe.cs.autoquest.tasktrees.treeifc; - /** *

- * This is an implementation of the visitor pattern. Through this, it is possible to effectively - * process a task instance tree. + * This is an implementation of the visitor pattern. Through this, it is + * possible to effectively process a task instance tree. *

* @@ -26,58 +25,64 @@ public interface ITaskInstanceVisitor { - /** - *

- * method called for each visited event task instance. - *

- * - * @param eventTaskInstance the event task instance to be processed - */ - public void visit(IEventTaskInstance eventTaskInstance); - - /** - *

- * method called for each visited iteration instance. - *

- * - * @param iterationInstance the iteration instance to be processed - */ - public void visit(IIterationInstance iterationInstance); - - /** - *

- * method called for each visited optional instance. - *

- * - * @param optionalInstance the optional instance to be processed - */ - public void visit(IOptionalInstance optionalInstance); - - /** - *

- * method called for each visited selection instance. - *

- * - * @param selectionInstance the selection instance to be processed - */ - public void visit(ISelectionInstance selectionInstance); - - /** - *

- * method called for each visited sequence instance. - *

- * - * @param sequenceInstance the sequence instance to be processed - */ - public void visit(ISequenceInstance sequenceInstance); + /** + *

+ * method called for each visited event task instance. + *

+ * + * @param eventTaskInstance + * the event task instance to be processed + */ + public void visit(IEventTaskInstance eventTaskInstance); - /** - *

- * method called for each other kind of visited task instance (implemented to support future - * versions). - *

- * - * @param taskInstance the task instance to be processed - */ - public void visit(ITaskInstance taskInstance); - + /** + *

+ * method called for each visited iteration instance. + *

+ * + * @param iterationInstance + * the iteration instance to be processed + */ + public void visit(IIterationInstance iterationInstance); + + /** + *

+ * method called for each visited optional instance. + *

+ * + * @param optionalInstance + * the optional instance to be processed + */ + public void visit(IOptionalInstance optionalInstance); + + /** + *

+ * method called for each visited selection instance. + *

+ * + * @param selectionInstance + * the selection instance to be processed + */ + public void visit(ISelectionInstance selectionInstance); + + /** + *

+ * method called for each visited sequence instance. + *

+ * + * @param sequenceInstance + * the sequence instance to be processed + */ + public void visit(ISequenceInstance sequenceInstance); + + /** + *

+ * method called for each other kind of visited task instance (implemented + * to support future versions). + *

+ * + * @param taskInstance + * the task instance to be processed + */ + public void visit(ITaskInstance taskInstance); + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskModel.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskModel.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskModel.java (revision 1733) @@ -21,8 +21,9 @@ /** *

- * This class represents a complete task model. A task model within AutoQUEST is usually generated - * based on user sessions. Therefore, the task model consists of the user sessions, the models - * of the identified tasks, as well as further information about the tasks (e.g. their - * occurrence count) for statistical processing. + * This class represents a complete task model. A task model within AutoQUEST is + * usually generated based on user sessions. Therefore, the task model consists + * of the user sessions, the models of the identified tasks, as well as further + * information about the tasks (e.g. their occurrence count) for statistical + * processing. *

* @@ -31,52 +32,53 @@ public interface ITaskModel extends Cloneable, Serializable { - /** - *

- * returns the user sessions belonging to the model. The return value may be null in the case - * no user sessions are associated the the tasks in the model. - *

- * - * @return as described - */ - public List getUserSessions(); + /** + *

+ * creates a deep clone of the model including all tasks and user sessions. + *

+ * + * @return as described + */ + public ITaskModel clone(); - /** - *

- * returns the tasks belonging to the model. The return value must not be null. However, - * it may be an empty list, if the model is an empty model. - *

- * - * @return as described - */ - public Collection getTasks(); + /** + *

+ * returns a list of all metrics calculated by this model for the tasks and + * stored in the respective task infos + *

+ * + * @return as described + */ + public TaskMetric[] getAllMetrics(); - /** - *

- * returns additional info for the provided task. The method returns null, if the provided - * task does not belong to the model. - *

- * - * @return as described - */ - public ITaskInfo getTaskInfo(ITask task); + /** + *

+ * returns additional info for the provided task. The method returns null, + * if the provided task does not belong to the model. + *

+ * + * @return as described + */ + public ITaskInfo getTaskInfo(ITask task); - /** - *

- * returns a list of all metrics calculated by this model for the tasks and stored in the - * respective task infos - *

- * - * @return as described - */ - public TaskMetric[] getAllMetrics(); + /** + *

+ * returns the tasks belonging to the model. The return value must not be + * null. However, it may be an empty list, if the model is an empty model. + *

+ * + * @return as described + */ + public Collection getTasks(); - /** - *

- * creates a deep clone of the model including all tasks and user sessions. - *

- * - * @return as described - */ - public ITaskModel clone(); + /** + *

+ * returns the user sessions belonging to the model. The return value may be + * null in the case no user sessions are associated the the tasks in the + * model. + *

+ * + * @return as described + */ + public List getUserSessions(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskVisitor.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskVisitor.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITaskVisitor.java (revision 1733) @@ -15,9 +15,8 @@ package de.ugoe.cs.autoquest.tasktrees.treeifc; - /** *

- * This is an implementation of the visitor pattern. Through this, it is possible to effectively - * process a task model. + * This is an implementation of the visitor pattern. Through this, it is + * possible to effectively process a task model. *

* @@ -26,57 +25,64 @@ public interface ITaskVisitor { - /** - *

- * method called for each visited event task. - *

- * - * @param eventTask the event task to be processed - */ - public void visit(IEventTask eventTask); - - /** - *

- * method called for each visited iteration. - *

- * - * @param iteration the iteration to be processed - */ - public void visit(IIteration iteration); - - /** - *

- * method called for each visited optional. - *

- * - * @param optional the optional to be processed - */ - public void visit(IOptional optional); - - /** - *

- * method called for each visited selection. - *

- * - * @param selection the selection to be processed - */ - public void visit(ISelection selection); - - /** - *

- * method called for each visited sequence. - *

- * - * @param sequence the sequence to be processed - */ - public void visit(ISequence sequence); + /** + *

+ * method called for each visited event task. + *

+ * + * @param eventTask + * the event task to be processed + */ + public void visit(IEventTask eventTask); - /** - *

- * method called for each other kind of visited task (implemented to support future versions). - *

- * - * @param task the task to be processed - */ - public void visit(ITask task); - + /** + *

+ * method called for each visited iteration. + *

+ * + * @param iteration + * the iteration to be processed + */ + public void visit(IIteration iteration); + + /** + *

+ * method called for each visited optional. + *

+ * + * @param optional + * the optional to be processed + */ + public void visit(IOptional optional); + + /** + *

+ * method called for each visited selection. + *

+ * + * @param selection + * the selection to be processed + */ + public void visit(ISelection selection); + + /** + *

+ * method called for each visited sequence. + *

+ * + * @param sequence + * the sequence to be processed + */ + public void visit(ISequence sequence); + + /** + *

+ * method called for each other kind of visited task (implemented to support + * future versions). + *

+ * + * @param task + * the task to be processed + */ + public void visit(ITask task); + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITemporalRelationship.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITemporalRelationship.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/ITemporalRelationship.java (revision 1733) @@ -17,10 +17,11 @@ /** *

- * A temporal relationship is a node in a task model which is no leaf node. They are used to - * structure the tasks in a task model into useful orders. A temporal relationship defines through - * its type how its children can be executed to fulfill the task they represent themselves. E.g., - * the task of filling out a form can be subdivided into several subtasks for filling out the - * different elements of the. The task itself will define the order, in which the fill out process - * can and must be done. + * A temporal relationship is a node in a task model which is no leaf node. They + * are used to structure the tasks in a task model into useful orders. A + * temporal relationship defines through its type how its children can be + * executed to fulfill the task they represent themselves. E.g., the task of + * filling out a form can be subdivided into several subtasks for filling out + * the different elements of the. The task itself will define the order, in + * which the fill out process can and must be done. *

* @@ -29,14 +30,16 @@ public interface ITemporalRelationship extends ITask { - /** - *

- * returns an exact copy of this temporal relationship. The clone has the same id. Its children - * are clones of the children of the cloned task. A call on the method {@link #equals(ITask)} - * with the result of this method must return true. - *

- * - * @return as described - */ - public ITemporalRelationship clone(); + /** + *

+ * returns an exact copy of this temporal relationship. The clone has the + * same id. Its children are clones of the children of the cloned task. A + * call on the method {@link #equals(ITask)} with the result of this method + * must return true. + *

+ * + * @return as described + */ + @Override + public ITemporalRelationship clone(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IUserSession.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IUserSession.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/IUserSession.java (revision 1733) @@ -19,7 +19,8 @@ /** *

- * A user session represents task executions, i.e. a task instances of a specific user that were - * executed in a coherent manner. Therefore, they are an ordered list of task instances where - * the order denotes the order of the task executions. + * A user session represents task executions, i.e. a task instances of a + * specific user that were executed in a coherent manner. Therefore, they are an + * ordered list of task instances where the order denotes the order of the task + * executions. *

* @@ -28,43 +29,47 @@ public interface IUserSession extends ITaskInstanceList { - /** - *

- * returns the list of task instances executed in the represented session. - *

- * - * @return as described - */ - public List getExecutedTasks(); - - /** - *

- * compares the user session with another one. Two user sessions are only equal, if they - * contain the same number of task instances and if each task instance at each position is - * equal to the respective other session. - *

- * - * @param userSession the session to compare the session to - * - * @return true if both sessions are equal, false else - */ - public boolean equals(IUserSession userSession); + /** + *

+ * clones a user session by creating exact clones of each contained instance + * in their order + *

+ * + * @return a clone of the session + */ + public IUserSession clone(); - /** - *

- * returns a hash code for the session to be able to store the session in a hash map. - *

- * - * @return as described - */ - public int hashCode(); + /** + *

+ * compares the user session with another one. Two user sessions are only + * equal, if they contain the same number of task instances and if each task + * instance at each position is equal to the respective other session. + *

+ * + * @param userSession + * the session to compare the session to + * + * @return true if both sessions are equal, false else + */ + public boolean equals(IUserSession userSession); - /** - *

- * clones a user session by creating exact clones of each contained instance in their order - *

- * - * @return a clone of the session - */ - public IUserSession clone(); + /** + *

+ * returns the list of task instances executed in the represented session. + *

+ * + * @return as described + */ + public List getExecutedTasks(); + + /** + *

+ * returns a hash code for the session to be able to store the session in a + * hash map. + *

+ * + * @return as described + */ + @Override + public int hashCode(); } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/TaskMetric.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/TaskMetric.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeifc/TaskMetric.java (revision 1733) @@ -19,6 +19,7 @@ /** *

- * represents different metrics available or calculatable for tasks. Measure for the metrics - * are calculated by a task model and added to the task infos of a specific task. + * represents different metrics available or calculatable for tasks. Measure for + * the metrics are calculated by a task model and added to the task infos of a + * specific task. *

* @@ -27,115 +28,117 @@ public enum TaskMetric { - COUNT("count", "number of all occurrences of the task in the model"), - DEPTH("depth", - "the maximum depth of the task, i.e., the number of children levels including the " + - "level of the task itself"), - EVENT_COVERAGE("covered events", "number of all event task instances covered by the task"), - EVENT_COVERAGE_RATIO("event coverage ratio", - "the ratio of events covered by this task in relation to all events " + - "covered by all tasks in their instances in per mille", 0.1, "%"), - EVENT_COVERAGE_QUANTILE("event coverage ratio quantile", - "the quantile of with respect to all event coverages begining with " + - "the lowest", 0.1, "%"); - - /** - *

- * the name of the metric - *

- */ - private String name; - - /** - *

- * a human readable description of the metric - *

- */ - private String description; + COUNT("count", "number of all occurrences of the task in the model"), DEPTH( + "depth", + "the maximum depth of the task, i.e., the number of children levels including the " + + "level of the task itself"), EVENT_COVERAGE( + "covered events", + "number of all event task instances covered by the task"), EVENT_COVERAGE_RATIO( + "event coverage ratio", + "the ratio of events covered by this task in relation to all events " + + "covered by all tasks in their instances in per mille", + 0.1, "%"), EVENT_COVERAGE_QUANTILE("event coverage ratio quantile", + "the quantile of with respect to all event coverages begining with " + + "the lowest", 0.1, "%"); - /** - *

- * a scale applied for the metric when formatting the value - *

- */ - private double formatScale; - - /** - *

- * the unit of the metric used when formatting the value - *

- */ - private String formatUnit; - - /** - *

- * initializes the metric with a name and a description - *

- */ - private TaskMetric(String name, String description) { - this.name = name; - this.description = description; - this.formatScale = 1.0; - this.formatUnit = null; - } + /** + *

+ * the name of the metric + *

+ */ + private String name; - /** - *

- * initializes the metric with a name and a description, as well as with a scale and a unit for - * formatting it. - *

- */ - private TaskMetric(String name, String description, double formatScale, String formatUnit) { - this.name = name; - this.description = description; - this.formatScale = formatScale; - this.formatUnit = formatUnit; - } + /** + *

+ * a human readable description of the metric + *

+ */ + private String description; - /** - *

- * returns the name of the metric - *

- * - * @return the name of the metric - */ - public String getName() { - return name; - } + /** + *

+ * a scale applied for the metric when formatting the value + *

+ */ + private double formatScale; - /** - *

- * returns the human readable description of the metric - *

- * - * @return the human readable description of the metric - */ - public String getDescription() { - return description; - } - - /** - *

- * formats the provided value of a measure of the metric using the internal format scale and - * unit. - *

- * - * @return the formatted value depending on the scale and unit of the metric - */ - public String formatValue(int value) { - String formattedValue; - - if (formatScale != 1.0) { - double effectiveValue = formatScale * value; - formattedValue = new DecimalFormat( "#,##0.0;(#)").format(effectiveValue); - } - else { - formattedValue = Integer.toString(value); - } - - if (formatUnit != null) { - formattedValue += formatUnit; - } - - return formattedValue; - } + /** + *

+ * the unit of the metric used when formatting the value + *

+ */ + private String formatUnit; + + /** + *

+ * initializes the metric with a name and a description + *

+ */ + private TaskMetric(String name, String description) { + this.name = name; + this.description = description; + this.formatScale = 1.0; + this.formatUnit = null; + } + + /** + *

+ * initializes the metric with a name and a description, as well as with a + * scale and a unit for formatting it. + *

+ */ + private TaskMetric(String name, String description, double formatScale, + String formatUnit) { + this.name = name; + this.description = description; + this.formatScale = formatScale; + this.formatUnit = formatUnit; + } + + /** + *

+ * formats the provided value of a measure of the metric using the internal + * format scale and unit. + *

+ * + * @return the formatted value depending on the scale and unit of the metric + */ + public String formatValue(int value) { + String formattedValue; + + if (formatScale != 1.0) { + final double effectiveValue = formatScale * value; + formattedValue = new DecimalFormat("#,##0.0;(#)") + .format(effectiveValue); + } else { + formattedValue = Integer.toString(value); + } + + if (formatUnit != null) { + formattedValue += formatUnit; + } + + return formattedValue; + } + + /** + *

+ * returns the human readable description of the metric + *

+ * + * @return the human readable description of the metric + */ + public String getDescription() { + return description; + } + + /** + *

+ * returns the name of the metric + *

+ * + * @return the name of the metric + */ + public String getName() { + return name; + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/EventTask.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/EventTask.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/EventTask.java (revision 1733) @@ -20,46 +20,52 @@ /** *

- * this is the default implementation of the interface {@link IEventTask}. It does not do anything - * fancy except implementing the interface. - *

+ * this is the default implementation of the interface {@link IEventTask}. It + * does not do anything fancy except implementing the interface. + *

* * @author Patrick Harms */ class EventTask extends Task implements IEventTask { - - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; - /** - *

- * simple constructor initializing this task with a description for the represented events - *

- * - * @param type a type for the represented events - */ - EventTask(String type) { - super(type); - } + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#clone() - */ - @Override - public EventTask clone() { - // Event type and target are unchangeable and do not need to be cloned - return (EventTask) super.clone(); - } + /** + *

+ * simple constructor initializing this task with a description for the + * represented events + *

+ * + * @param type + * a type for the represented events + */ + EventTask(String type) { + super(type); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#accept(ITaskVisitor) - */ - @Override - public void accept(ITaskVisitor visitor) { - visitor.visit(this); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#accept(ITaskVisitor) + */ + @Override + public void accept(ITaskVisitor visitor) { + visitor.visit(this); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#clone() + */ + @Override + public EventTask clone() { + // Event type and target are unchangeable and do not need to be cloned + return (EventTask) super.clone(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/EventTaskInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/EventTaskInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/EventTaskInstance.java (revision 1733) @@ -28,54 +28,64 @@ class EventTaskInstance extends TaskInstance implements IEventTaskInstance { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; - - /** - *

- * the event represented by this instance - *

- */ - private Event event; + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * initializes this instance with the respective task model and the represented event - *

- * - * @param task the task of which this is an instance - * @param event the event represented by this instance - */ - EventTaskInstance(IEventTask task, Event event) { - super(task); - this.event = event; - } + /** + *

+ * the event represented by this instance + *

+ */ + private final Event event; - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTaskInstance#getEvent() - */ - @Override - public Event getEvent() { - return event; - } + /** + *

+ * initializes this instance with the respective task model and the + * represented event + *

+ * + * @param task + * the task of which this is an instance + * @param event + * the event represented by this instance + */ + EventTaskInstance(IEventTask task, Event event) { + super(task); + this.event = event; + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTaskInstance#getEventTask() - */ - @Override - public IEventTask getEventTask() { - return (IEventTask) super.getTask(); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.IEventTaskInstance#clone() + */ + @Override + public synchronized IEventTaskInstance clone() { + return (IEventTaskInstance) super.clone(); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.IEventTaskInstance#clone() - */ - @Override - public synchronized IEventTaskInstance clone() { - return (IEventTaskInstance) super.clone(); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTaskInstance#getEvent() + */ + @Override + public Event getEvent() { + return event; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.IEventTaskInstance#getEventTask() + */ + @Override + public IEventTask getEventTask() { + return (IEventTask) super.getTask(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Iteration.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Iteration.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Iteration.java (revision 1733) @@ -21,7 +21,7 @@ /** *

- * this is the default implementation of the interface {@link IIteration}. It does not do anything - * fancy except implementing the interface. - *

+ * this is the default implementation of the interface {@link IIteration}. It + * does not do anything fancy except implementing the interface. + *

* * @author Patrick Harms @@ -29,45 +29,51 @@ class Iteration extends MarkingTemporalRelationship implements IIteration { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * simple constructor providing the base class with a human readable name of the type of this - * task - *

- */ - Iteration() { - super("iteration"); - } + /** + *

+ * simple constructor providing the base class with a human readable name of + * the type of this task + *

+ */ + Iteration() { + super("iteration"); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#setMarkedTask(ITask) - */ - @Override - protected void setMarkedTask(ITask markedTask) { - if (markedTask instanceof IIteration) { - throw new IllegalArgumentException - ("the marked task of an iteration must not be an iteration"); - } - else if (markedTask instanceof IOptional) { - throw new IllegalArgumentException - ("the marked task of an iteration must not be an optional"); - } - - super.setMarkedTask(markedTask); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#clone + * () + */ + @Override + public Iteration clone() { + return (Iteration) super.clone(); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#clone() - */ - @Override - public Iteration clone() { - return (Iteration) super.clone(); - } - + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship# + * setMarkedTask(ITask) + */ + @Override + protected void setMarkedTask(ITask markedTask) { + if (markedTask instanceof IIteration) { + throw new IllegalArgumentException( + "the marked task of an iteration must not be an iteration"); + } else if (markedTask instanceof IOptional) { + throw new IllegalArgumentException( + "the marked task of an iteration must not be an optional"); + } + + super.setMarkedTask(markedTask); + } + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/IterationInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/IterationInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/IterationInstance.java (revision 1733) @@ -33,149 +33,164 @@ class IterationInstance extends TaskInstance implements IIterationInstance { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * the children of this task instance which are task instances, as well - *

- */ - private List children; + /** + *

+ * the children of this task instance which are task instances, as well + *

+ */ + private List children; - /** - *

- * initializes this instance with the respective task model - *

- * - * @param task the task of which this is an instance - */ - IterationInstance(IIteration task) { - super(task); - } + /** + *

+ * initializes this instance with the respective task model + *

+ * + * @param task + * the task of which this is an instance + */ + IterationInstance(IIteration task) { + super(task); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance#getChildren() - */ - public synchronized List getChildren() { - if (children == null) { - children = new LinkedList(); - } + /** + *

+ * used to add a child to this task instance at a specific position + *

+ * + * @param index + * the position of the new child in the list of children + * @param child + * the new child of this instance + */ + synchronized void addChild(int index, ITaskInstance child) { + if (children == null) { + children = new LinkedList(); + } - return Collections.unmodifiableList(children); - } + children.add(index, child); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#get(int) - */ - @Override - public ITaskInstance get(int index) { - if (children == null) { - throw new IndexOutOfBoundsException(Integer.toString(index)); - } - else { - return children.get(index); - } - } + /** + *

+ * used to add a child to this task instance + *

+ * + * @param child + * the new child of this instance + */ + synchronized void addChild(ITaskInstance child) { + if (children == null) { + children = new LinkedList(); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#size() - */ - @Override - public int size() { - if (children == null) { - return 0; - } - else { - return children.size(); - } - } + children.add(child); + } - /* (non-Javadoc) - * @see java.lang.Iterable#iterator() - */ - @Override - public Iterator iterator() { - return getChildren().iterator(); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.IIterationInstance#clone() + */ + @Override + public synchronized IIterationInstance clone() { + final IterationInstance clone = (IterationInstance) super.clone(); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IIterationInstance#getIteration() - */ - @Override - public IIteration getIteration() { - return (IIteration) super.getTask(); - } + if (children != null) { + clone.children = new LinkedList(); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.IIterationInstance#clone() - */ - @Override - public synchronized IIterationInstance clone() { - IterationInstance clone = (IterationInstance) super.clone(); + for (final ITaskInstance child : children) { + clone.children.add(child.clone()); + } + } - if (children != null) { - clone.children = new LinkedList(); + return clone; + } - for (ITaskInstance child : children) { - clone.children.add(child.clone()); - } - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#get(int) + */ + @Override + public ITaskInstance get(int index) { + if (children == null) { + throw new IndexOutOfBoundsException(Integer.toString(index)); + } else { + return children.get(index); + } + } - return clone; - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance#getChildren() + */ + public synchronized List getChildren() { + if (children == null) { + children = new LinkedList(); + } - /** - *

- * used to add a child to this task instance - *

- * - * @param child the new child of this instance - */ - synchronized void addChild(ITaskInstance child) { - if (children == null) { - children = new LinkedList(); - } + return Collections.unmodifiableList(children); + } - children.add(child); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.IIterationInstance#getIteration() + */ + @Override + public IIteration getIteration() { + return (IIteration) super.getTask(); + } - /** - *

- * used to add a child to this task instance at a specific position - *

- * - * @param index the position of the new child in the list of children - * @param child the new child of this instance - */ - synchronized void addChild(int index, ITaskInstance child) { - if (children == null) { - children = new LinkedList(); - } + /* + * (non-Javadoc) + * + * @see java.lang.Iterable#iterator() + */ + @Override + public Iterator iterator() { + return getChildren().iterator(); + } - children.add(index, child); - } + /** + *

+ * removes a child from this task instance at a specific position + *

+ * + * @param index + * the position of the child to be removed + * + * @return the child removed from the children of this instance + */ + synchronized ITaskInstance removeChild(int index) { + if (children != null) { + return children.remove(index); + } else { + throw new IllegalArgumentException( + "this task instance does not have children that can be removed"); + } + } - /** - *

- * removes a child from this task instance at a specific position - *

- * - * @param index the position of the child to be removed - * - * @return the child removed from the children of this instance - */ - synchronized ITaskInstance removeChild(int index) { - if (children != null) { - return children.remove(index); - } - else { - throw new IllegalArgumentException - ("this task instance does not have children that can be removed"); - } - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#size() + */ + @Override + public int size() { + if (children == null) { + return 0; + } else { + return children.size(); + } + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/MarkingTemporalRelationship.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/MarkingTemporalRelationship.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/MarkingTemporalRelationship.java (revision 1733) @@ -20,79 +20,86 @@ /** *

- * this is the default implementation of the interface {@link IMarkingTemporalRelationship}. It - * does not do anything fancy except implementing the interface. + * this is the default implementation of the interface + * {@link IMarkingTemporalRelationship}. It does not do anything fancy except + * implementing the interface. *

* * @author Patrick Harms */ -abstract class MarkingTemporalRelationship extends Task - implements IMarkingTemporalRelationship -{ +abstract class MarkingTemporalRelationship extends Task implements + IMarkingTemporalRelationship { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * the task marked through this marking temporal relationship - *

- */ - private ITask markedTask; - - /** - *

- * initializes this temporal relationship with a human readable name - *

- * - * @param relationshipType the human readable name of this temporal relationship - */ - MarkingTemporalRelationship(String relationshipType) { - super(relationshipType); - - if ((relationshipType == null) || ("".equals(relationshipType))) { - throw new IllegalArgumentException - ("the relationship type must be something meaningful"); - } - } + /** + *

+ * the task marked through this marking temporal relationship + *

+ */ + private ITask markedTask; - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IMarkingTemporalRelationship#getMarkedTask() - */ - @Override - public ITask getMarkedTask() { - return markedTask; - } + /** + *

+ * initializes this temporal relationship with a human readable name + *

+ * + * @param relationshipType + * the human readable name of this temporal relationship + */ + MarkingTemporalRelationship(String relationshipType) { + super(relationshipType); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#clone() - */ - @Override - public synchronized MarkingTemporalRelationship clone() { - MarkingTemporalRelationship clone = null; - clone = (MarkingTemporalRelationship) super.clone(); - - if (markedTask != null) { - clone.markedTask = markedTask.clone(); - } + if ((relationshipType == null) || ("".equals(relationshipType))) { + throw new IllegalArgumentException( + "the relationship type must be something meaningful"); + } + } - return clone; - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#clone() + */ + @Override + public synchronized MarkingTemporalRelationship clone() { + MarkingTemporalRelationship clone = null; + clone = (MarkingTemporalRelationship) super.clone(); - /** - *

- * used to set the marked task - *

- * - * @param markedTask the marked task to set - */ - protected void setMarkedTask(ITask markedTask) { - this.markedTask = markedTask; - - super.setDescription(markedTask.toString()); - } + if (markedTask != null) { + clone.markedTask = markedTask.clone(); + } + + return clone; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IMarkingTemporalRelationship# + * getMarkedTask() + */ + @Override + public ITask getMarkedTask() { + return markedTask; + } + + /** + *

+ * used to set the marked task + *

+ * + * @param markedTask + * the marked task to set + */ + protected void setMarkedTask(ITask markedTask) { + this.markedTask = markedTask; + + super.setDescription(markedTask.toString()); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Optional.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Optional.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Optional.java (revision 1733) @@ -20,7 +20,7 @@ /** *

- * this is the default implementation of the interface {@link IOptional}. It does not do anything - * fancy except implementing the interface. - *

+ * this is the default implementation of the interface {@link IOptional}. It + * does not do anything fancy except implementing the interface. + *

* * @author Patrick Harms @@ -28,41 +28,48 @@ class Optional extends MarkingTemporalRelationship implements IOptional { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * simple constructor providing the base class with a human readable name of the type of this - * task - *

- */ - Optional() { - super("optionality"); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#setMarkedTask(ITask) - */ - @Override - protected void setMarkedTask(ITask markedTask) { - if (markedTask instanceof IOptional) { - throw new IllegalArgumentException - ("the marked task of an optional must not be an optional"); - } - - super.setMarkedTask(markedTask); - } + /** + *

+ * simple constructor providing the base class with a human readable name of + * the type of this task + *

+ */ + Optional() { + super("optionality"); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#clone() - */ - @Override - public Optional clone() { - return (Optional) super.clone(); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship#clone + * () + */ + @Override + public Optional clone() { + return (Optional) super.clone(); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.MarkingTemporalRelationship# + * setMarkedTask(ITask) + */ + @Override + protected void setMarkedTask(ITask markedTask) { + if (markedTask instanceof IOptional) { + throw new IllegalArgumentException( + "the marked task of an optional must not be an optional"); + } + + super.setMarkedTask(markedTask); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/OptionalInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/OptionalInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/OptionalInstance.java (revision 1733) @@ -29,73 +29,83 @@ class OptionalInstance extends TaskInstance implements IOptionalInstance { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * the child of this task instance if any - *

- */ - private ITaskInstance child; - - /** - *

- * initializes this instance with the respective task model - *

- * - * @param task the task of which this is an instance - */ - OptionalInstance(ITask task) { - super(task); - } + /** + *

+ * the child of this task instance if any + *

+ */ + private ITaskInstance child; - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IOptionalInstance#getChild() - */ - @Override - public ITaskInstance getChild() { - return child; - } + /** + *

+ * initializes this instance with the respective task model + *

+ * + * @param task + * the task of which this is an instance + */ + OptionalInstance(ITask task) { + super(task); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IOptionalInstance#getOptional() - */ - @Override - public IOptional getOptional() { - return (IOptional) super.getTask(); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.ISequenceInstance#clone() + */ + @Override + public synchronized IOptionalInstance clone() { + final OptionalInstance clone = (OptionalInstance) super.clone(); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.ISequenceInstance#clone() - */ - @Override - public synchronized IOptionalInstance clone() { - OptionalInstance clone = (OptionalInstance) super.clone(); + if (child != null) { + clone.child = child.clone(); + } - if (child != null) { - clone.child = child.clone(); - } + return clone; + } - return clone; - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IOptionalInstance#getChild() + */ + @Override + public ITaskInstance getChild() { + return child; + } - /** - *

- * used to set the child of this task instance - *

- * - * @param child the new child of this instance - */ - void setChild(ITaskInstance child) { - if (child instanceof IOptionalInstance) { - throw new IllegalArgumentException("the child of an optional can not be an optional"); - } - - this.child = child; - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.IOptionalInstance#getOptional() + */ + @Override + public IOptional getOptional() { + return (IOptional) super.getTask(); + } + + /** + *

+ * used to set the child of this task instance + *

+ * + * @param child + * the new child of this instance + */ + void setChild(ITaskInstance child) { + if (child instanceof IOptionalInstance) { + throw new IllegalArgumentException( + "the child of an optional can not be an optional"); + } + + this.child = child; + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Selection.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Selection.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Selection.java (revision 1733) @@ -20,7 +20,7 @@ /** *

- * this is the default implementation of the interface {@link ISelection}. It does not do anything - * fancy except implementing the interface. - *

+ * this is the default implementation of the interface {@link ISelection}. It + * does not do anything fancy except implementing the interface. + *

* * @author Patrick Harms @@ -28,44 +28,56 @@ class Selection extends StructuringTemporalRelationship implements ISelection { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * simple constructor providing the base class with a human readable name of the type of this - * task - *

- */ - Selection() { - super("selection"); - } + /** + *

+ * simple constructor providing the base class with a human readable name of + * the type of this task + *

+ */ + Selection() { + super("selection"); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship#clone() - */ - @Override - public Selection clone() { - return (Selection) super.clone(); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship + * #addChild(int,ITask) + */ + @Override + void addChild(int index, ITask newChild) { + super.addChild(index, newChild); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship#addChild(ITask) - */ - @Override - void addChild(ITask newChild) { - super.addChild(newChild); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship + * #addChild(ITask) + */ + @Override + void addChild(ITask newChild) { + super.addChild(newChild); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship#addChild(int,ITask) - */ - @Override - void addChild(int index, ITask newChild) { - super.addChild(index, newChild); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship + * #clone() + */ + @Override + public Selection clone() { + return (Selection) super.clone(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/SelectionInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/SelectionInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/SelectionInstance.java (revision 1733) @@ -29,73 +29,83 @@ class SelectionInstance extends TaskInstance implements ISelectionInstance { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * the child of this task instance - *

- */ - private ITaskInstance child; - - /** - *

- * initializes this instance with the respective task model - *

- * - * @param task the task of which this is an instance - */ - SelectionInstance(ITask task) { - super(task); - } + /** + *

+ * the child of this task instance + *

+ */ + private ITaskInstance child; - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ISelectionInstance#getChild() - */ - @Override - public ITaskInstance getChild() { - return child; - } + /** + *

+ * initializes this instance with the respective task model + *

+ * + * @param task + * the task of which this is an instance + */ + SelectionInstance(ITask task) { + super(task); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ISelectionInstance#getSelection() - */ - @Override - public ISelection getSelection() { - return (ISelection) super.getTask(); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.ISequenceInstance#clone() + */ + @Override + public synchronized ISelectionInstance clone() { + final SelectionInstance clone = (SelectionInstance) super.clone(); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.ISequenceInstance#clone() - */ - @Override - public synchronized ISelectionInstance clone() { - SelectionInstance clone = (SelectionInstance) super.clone(); + if (child != null) { + clone.child = child.clone(); + } - if (child != null) { - clone.child = child.clone(); - } + return clone; + } - return clone; - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ISelectionInstance#getChild() + */ + @Override + public ITaskInstance getChild() { + return child; + } - /** - *

- * used to set the child of this task instance - *

- * - * @param child the new child of this instance - */ - void setChild(ITaskInstance child) { - if (child instanceof ISelectionInstance) { - throw new IllegalArgumentException("the child of a selection can not be a selection"); - } - - this.child = child; - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ISelectionInstance#getSelection() + */ + @Override + public ISelection getSelection() { + return (ISelection) super.getTask(); + } + + /** + *

+ * used to set the child of this task instance + *

+ * + * @param child + * the new child of this instance + */ + void setChild(ITaskInstance child) { + if (child instanceof ISelectionInstance) { + throw new IllegalArgumentException( + "the child of a selection can not be a selection"); + } + + this.child = child; + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Sequence.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Sequence.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Sequence.java (revision 1733) @@ -19,36 +19,40 @@ /** *

- * this is the default implementation of the interface {@link ISequence}. It does not do anything - * fancy except implementing the interface. - *

+ * this is the default implementation of the interface {@link ISequence}. It + * does not do anything fancy except implementing the interface. + *

* * @author Patrick Harms */ class Sequence extends StructuringTemporalRelationship implements ISequence { - - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; - /** - *

- * simple constructor providing the base class with a human readable name of the type of this - * task - *

- */ - Sequence() { - super("sequence"); - } + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship#clone() - */ - @Override - public Sequence clone() { - return (Sequence) super.clone(); - } - + /** + *

+ * simple constructor providing the base class with a human readable name of + * the type of this task + *

+ */ + Sequence() { + super("sequence"); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeimpl.StructuringTemporalRelationship + * #clone() + */ + @Override + public Sequence clone() { + return (Sequence) super.clone(); + } + } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/SequenceInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/SequenceInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/SequenceInstance.java (revision 1733) @@ -34,149 +34,164 @@ class SequenceInstance extends TaskInstance implements ISequenceInstance { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * the children of this task instance which are task instances, as well - *

- */ - private List children; + /** + *

+ * the children of this task instance which are task instances, as well + *

+ */ + private List children; - /** - *

- * initializes this instance with the respective task model - *

- * - * @param task the task of which this is an instance - */ - SequenceInstance(ISequence task) { - super(task); - } + /** + *

+ * initializes this instance with the respective task model + *

+ * + * @param task + * the task of which this is an instance + */ + SequenceInstance(ISequence task) { + super(task); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance#getChildren() - */ - public synchronized List getChildren() { - if (children == null) { - children = new LinkedList(); - } + /** + *

+ * used to add a child to this task instance at a specific position + *

+ * + * @param index + * the position of the new child in the list of children + * @param child + * the new child of this instance + */ + synchronized void addChild(int index, ITaskInstance child) { + if (children == null) { + children = new LinkedList(); + } - return Collections.unmodifiableList(children); - } + children.add(index, child); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#get(int) - */ - @Override - public ITaskInstance get(int index) { - if (children == null) { - throw new IndexOutOfBoundsException(Integer.toString(index)); - } - else { - return children.get(index); - } - } + /** + *

+ * used to add a child to this task instance + *

+ * + * @param child + * the new child of this instance + */ + synchronized void addChild(ITaskInstance child) { + if (children == null) { + children = new LinkedList(); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#size() - */ - @Override - public int size() { - if (children == null) { - return 0; - } - else { - return children.size(); - } - } + children.add(child); + } - /* (non-Javadoc) - * @see java.lang.Iterable#iterator() - */ - @Override - public Iterator iterator() { - return getChildren().iterator(); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.ISequenceInstance#clone() + */ + @Override + public synchronized ISequenceInstance clone() { + final SequenceInstance clone = (SequenceInstance) super.clone(); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ISequenceInstance#getSequence() - */ - @Override - public ISequence getSequence() { - return (ISequence) super.getTask(); - } + if (children != null) { + clone.children = new LinkedList(); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.ISequenceInstance#clone() - */ - @Override - public synchronized ISequenceInstance clone() { - SequenceInstance clone = (SequenceInstance) super.clone(); + for (final ITaskInstance child : children) { + clone.children.add(child.clone()); + } + } - if (children != null) { - clone.children = new LinkedList(); + return clone; + } - for (ITaskInstance child : children) { - clone.children.add(child.clone()); - } - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#get(int) + */ + @Override + public ITaskInstance get(int index) { + if (children == null) { + throw new IndexOutOfBoundsException(Integer.toString(index)); + } else { + return children.get(index); + } + } - return clone; - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance#getChildren() + */ + public synchronized List getChildren() { + if (children == null) { + children = new LinkedList(); + } - /** - *

- * used to add a child to this task instance - *

- * - * @param child the new child of this instance - */ - synchronized void addChild(ITaskInstance child) { - if (children == null) { - children = new LinkedList(); - } + return Collections.unmodifiableList(children); + } - children.add(child); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ISequenceInstance#getSequence() + */ + @Override + public ISequence getSequence() { + return (ISequence) super.getTask(); + } - /** - *

- * used to add a child to this task instance at a specific position - *

- * - * @param index the position of the new child in the list of children - * @param child the new child of this instance - */ - synchronized void addChild(int index, ITaskInstance child) { - if (children == null) { - children = new LinkedList(); - } + /* + * (non-Javadoc) + * + * @see java.lang.Iterable#iterator() + */ + @Override + public Iterator iterator() { + return getChildren().iterator(); + } - children.add(index, child); - } + /** + *

+ * removes a child from this task instance at a specific position + *

+ * + * @param index + * the position of the child to be removed + * + * @return the child removed from the children of this instance + */ + synchronized ITaskInstance removeChild(int index) { + if (children != null) { + return children.remove(index); + } else { + throw new IllegalArgumentException( + "this task instance does not have children that can be removed"); + } + } - /** - *

- * removes a child from this task instance at a specific position - *

- * - * @param index the position of the child to be removed - * - * @return the child removed from the children of this instance - */ - synchronized ITaskInstance removeChild(int index) { - if (children != null) { - return children.remove(index); - } - else { - throw new IllegalArgumentException - ("this task instance does not have children that can be removed"); - } - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#size() + */ + @Override + public int size() { + if (children == null) { + return 0; + } else { + return children.size(); + } + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/StructuringTemporalRelationship.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/StructuringTemporalRelationship.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/StructuringTemporalRelationship.java (revision 1733) @@ -23,101 +23,113 @@ /** *

- * this is the default implementation of the interface {@link IStructuringTemporalRelationship}. It - * does not do anything fancy except implementing the interface. + * this is the default implementation of the interface + * {@link IStructuringTemporalRelationship}. It does not do anything fancy + * except implementing the interface. *

* * @author Patrick Harms */ -abstract class StructuringTemporalRelationship extends Task - implements IStructuringTemporalRelationship -{ +abstract class StructuringTemporalRelationship extends Task implements + IStructuringTemporalRelationship { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; - - /** - *

- * the list of children of this temporal relationship - *

- */ - private List children = new LinkedList(); + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * initializes this temporal relationship with a human readable name - *

- * - * @param relationshipType the human readable name of this temporal relationship - */ - StructuringTemporalRelationship(String relationshipType) { - super(relationshipType); - - if ((relationshipType == null) || ("".equals(relationshipType))) { - throw new IllegalArgumentException - ("the relationship type must be something meaningful"); - } - } + /** + *

+ * the list of children of this temporal relationship + *

+ */ + private List children = new LinkedList(); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IStructuringTemporalRelationship#getChildren() - */ - @Override - public List getChildren() { - return children; - } + /** + *

+ * initializes this temporal relationship with a human readable name + *

+ * + * @param relationshipType + * the human readable name of this temporal relationship + */ + StructuringTemporalRelationship(String relationshipType) { + super(relationshipType); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#clone() - */ - @Override - public synchronized StructuringTemporalRelationship clone() { - StructuringTemporalRelationship clone = null; - clone = (StructuringTemporalRelationship) super.clone(); - - clone.children = new LinkedList(); - - for (ITask child : this.children) { - clone.children.add(child.clone()); - } + if ((relationshipType == null) || ("".equals(relationshipType))) { + throw new IllegalArgumentException( + "the relationship type must be something meaningful"); + } + } - return clone; - } + /** + *

+ * used to add a new child to this temporal relationship at a specific + * position. + *

+ * + * @param index + * the index of the new child to be added. + * @param newChild + * the new child to be added + */ + void addChild(int index, ITask newChild) { + children.add(index, newChild); + } - /** - *

- * used to add a new child to this temporal relationship. - *

- * - * @param newChild the new child to be added - */ - void addChild(ITask newChild) { - children.add(newChild); - } + /** + *

+ * used to add a new child to this temporal relationship. + *

+ * + * @param newChild + * the new child to be added + */ + void addChild(ITask newChild) { + children.add(newChild); + } - /** - *

- * used to add a new child to this temporal relationship at a specific position. - *

- * - * @param index the index of the new child to be added. - * @param newChild the new child to be added - */ - void addChild(int index, ITask newChild) { - children.add(index, newChild); - } - - /** - *

- * removes a child from this temporal relationship at a specific position. - *

- * - * @param index the index of the child to be removed. - */ - void removeChild(int index) { - children.remove(index); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeimpl.Task#clone() + */ + @Override + public synchronized StructuringTemporalRelationship clone() { + StructuringTemporalRelationship clone = null; + clone = (StructuringTemporalRelationship) super.clone(); + + clone.children = new LinkedList(); + + for (final ITask child : this.children) { + clone.children.add(child.clone()); + } + + return clone; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.IStructuringTemporalRelationship + * #getChildren() + */ + @Override + public List getChildren() { + return children; + } + + /** + *

+ * removes a child from this temporal relationship at a specific position. + *

+ * + * @param index + * the index of the child to be removed. + */ + void removeChild(int index) { + children.remove(index); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Task.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Task.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Task.java (revision 1733) @@ -32,6 +32,6 @@ /** *

- * this is the default implementation of the interface {@link ITask}. It - * does not do anything fancy except implementing the interface. + * this is the default implementation of the interface {@link ITask}. It does + * not do anything fancy except implementing the interface. *

* @@ -40,328 +40,352 @@ abstract class Task implements ITask { - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; - - /** - *

- * used as a counter to generate new ids for each newly created task. May overflow. - *

- */ - private static int temporalId = 0; - - /** - *

- * the id of the task (unique throughout the system as long as {@link #temporalId} does not - * overflow. - *

- */ - private int id; - - /** - *

- * a human readable type of the task (used for visualization purposes) - *

- */ - private String type; - - /** - *

- * a human readable description of the task - *

- */ - private String description; - - /** - *

- * the instances of this task - *

- */ - private Collection instances = new HashSet(); - - /** - *

- * the execution variants of this task - *

- */ - private Collection> executionVariants; - - /** - *

- * constructs a new task with a new id. The id is generated using the {@link #getNewId()} - * method - *

- * - * @param type the human readable type of the task - * - * @throws IllegalArgumentException in the case the provided type is null - */ - Task(String type) { - this.id = getNewId(); - this.type = type; - - if (type == null) { - throw new IllegalArgumentException("type must not be null"); - } - } - - /** - *

- * creates a new id for a task using {@link #temporalId} by incrementing it an returning its - * current value. Resets the counter if {@link Integer.MAX_VALUE} is reached. - *

- * - * @return a new unique id for a task as long as {@link #temporalId} does not overflow - */ - private static synchronized int getNewId() { - if (temporalId == Integer.MAX_VALUE) { - temporalId = 0; - } - - return temporalId++; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#geId() - */ - @Override - public int getId() { - return id; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getType() - */ - @Override - public String getType() { - return type; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getDescription() - */ - @Override - public String getDescription() { - return description; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getInstances() - */ - @Override - public Collection getInstances() { - return Collections.unmodifiableCollection(instances); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getExecutionVariants() - */ - @Override - public synchronized Collection> getExecutionVariants() { - if (executionVariants == null) { - executionVariants = new LinkedList>(); - determineExecutionVariants(executionVariants); - } - - return executionVariants; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#equals(ITask) - */ - @Override - public final boolean equals(ITask task) { - // tasks are only equal if they are identical or if they have the same id - // (may happen, if they are cloned) - return (this == task) || (this.hashCode() == task.hashCode()); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#hashCode() - */ - @Override - public synchronized int hashCode() { - return id; - } - - /* (non-Javadoc) - * @see java.lang.Object#toString() - */ - @Override - public synchronized String toString() { - StringBuffer result = new StringBuffer(); - result.append(type); - result.append(" #"); - result.append(id); - - if (description != null) { - result.append(" ("); - result.append(description); - result.append(')'); - } - - return result.toString(); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#clone() - */ - @Override - public synchronized ITask clone() { - Task clone = null; - try { - clone = (Task) super.clone(); - } - catch (CloneNotSupportedException e) { - // this should never happen. Therefore simply dump the exception - e.printStackTrace(); - } - - return clone; - } - - /** - *

- * internally used to set the human readable description of the task - *

- * - * @param description the new human readable description of the task - */ - void setDescription(String description) { - this.description = description; - } - - /** - *

- * internally used to remove an instance from this task - *

- * - * @param instance the instance to be removed from this task - */ - synchronized void removeInstance(ITaskInstance instance) { - this.instances.remove(instance); - this.executionVariants = null; - } - - /** - *

- * internally used to add an instance to this task - *

- * - * @param instance the instance belonging to this task - */ - synchronized void addInstance(ITaskInstance instance) { - this.instances.add(instance); - this.executionVariants = null; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#accept(ITaskVisitor) - */ - @Override - public void accept(ITaskVisitor visitor) { - visitor.visit(this); - } - - /** - * - */ - private void determineExecutionVariants(Collection> executionVariants) - { - for (ITaskInstance instance : instances) { - boolean added = false; - for (Collection variant : executionVariants) { - if (!variant.isEmpty() && (isSameExecution(variant.iterator().next(), instance))) { - variant.add(instance); - added = true; - } - } - - if (!added) { - Collection variant = new HashSet(); - variant.add(instance); - executionVariants.add(variant); - } - } - } - - /** - * - */ - private boolean isSameExecution(ITaskInstance instance1, ITaskInstance instance2) { - if (instance1 instanceof IIterationInstance) { - if (!(instance2 instanceof IIterationInstance)) { - return false; - } - - ITaskInstanceList iteration1 = (ITaskInstanceList) instance1; - ITaskInstanceList iteration2 = (ITaskInstanceList) instance2; - - return isSameExecutionList(iteration1, iteration2); - } - else if (instance1 instanceof ISequenceInstance) { - if (!(instance2 instanceof ISequenceInstance)) { - return false; - } - - ITaskInstanceList selection1 = (ITaskInstanceList) instance1; - ITaskInstanceList selection2 = (ITaskInstanceList) instance2; - - return isSameExecutionList(selection1, selection2); - } - else if (instance1 instanceof ISelectionInstance) { - if (!(instance2 instanceof ISelectionInstance)) { - return false; - } - else { - return isSameExecution(((ISelectionInstance) instance1).getChild(), - ((ISelectionInstance) instance2).getChild()); - } - } - else if (instance1 instanceof IOptionalInstance) { - if (!(instance2 instanceof IOptionalInstance)) { - return false; - } - else { - return isSameExecution(((IOptionalInstance) instance1).getChild(), - ((IOptionalInstance) instance2).getChild()); - } - } - else if (instance1 instanceof IEventTaskInstance) { - if (!(instance2 instanceof IEventTaskInstance)) { - return false; - } - else { - return ((IEventTaskInstance) instance1).getTask().equals - (((IEventTaskInstance) instance2).getTask()); - } - } - else if (instance1 == null) { - return instance2 == null; - } - else { - throw new IllegalArgumentException("unknown type of task instance: " + instance1); - } - } - - /** - * - */ - private boolean isSameExecutionList(ITaskInstanceList list1, ITaskInstanceList list2) { - if (list1.size() == list2.size()) { - for (int i = 0; i < list1.size(); i++) { - if (!isSameExecution(list1.get(i), list2.get(i))) { - return false; - } - } - - return true; - } - else { - return false; - } - } + /** + *

+ * creates a new id for a task using {@link #temporalId} by incrementing it + * an returning its current value. Resets the counter if + * {@link Integer.MAX_VALUE} is reached. + *

+ * + * @return a new unique id for a task as long as {@link #temporalId} does + * not overflow + */ + private static synchronized int getNewId() { + if (temporalId == Integer.MAX_VALUE) { + temporalId = 0; + } + + return temporalId++; + } + + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; + + /** + *

+ * used as a counter to generate new ids for each newly created task. May + * overflow. + *

+ */ + private static int temporalId = 0; + + /** + *

+ * the id of the task (unique throughout the system as long as + * {@link #temporalId} does not overflow. + *

+ */ + private final int id; + + /** + *

+ * a human readable type of the task (used for visualization purposes) + *

+ */ + private final String type; + + /** + *

+ * a human readable description of the task + *

+ */ + private String description; + + /** + *

+ * the instances of this task + *

+ */ + private final Collection instances = new HashSet(); + + /** + *

+ * the execution variants of this task + *

+ */ + private Collection> executionVariants; + + /** + *

+ * constructs a new task with a new id. The id is generated using the + * {@link #getNewId()} method + *

+ * + * @param type + * the human readable type of the task + * + * @throws IllegalArgumentException + * in the case the provided type is null + */ + Task(String type) { + this.id = getNewId(); + this.type = type; + + if (type == null) { + throw new IllegalArgumentException("type must not be null"); + } + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#accept(ITaskVisitor) + */ + @Override + public void accept(ITaskVisitor visitor) { + visitor.visit(this); + } + + /** + *

+ * internally used to add an instance to this task + *

+ * + * @param instance + * the instance belonging to this task + */ + synchronized void addInstance(ITaskInstance instance) { + this.instances.add(instance); + this.executionVariants = null; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#clone() + */ + @Override + public synchronized ITask clone() { + Task clone = null; + try { + clone = (Task) super.clone(); + } catch (final CloneNotSupportedException e) { + // this should never happen. Therefore simply dump the exception + e.printStackTrace(); + } + + return clone; + } + + /** + * + */ + private void determineExecutionVariants( + Collection> executionVariants) { + for (final ITaskInstance instance : instances) { + boolean added = false; + for (final Collection variant : executionVariants) { + if (!variant.isEmpty() + && (isSameExecution(variant.iterator().next(), instance))) { + variant.add(instance); + added = true; + } + } + + if (!added) { + final Collection variant = new HashSet(); + variant.add(instance); + executionVariants.add(variant); + } + } + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#equals(ITask) + */ + @Override + public final boolean equals(ITask task) { + // tasks are only equal if they are identical or if they have the same + // id + // (may happen, if they are cloned) + return (this == task) || (this.hashCode() == task.hashCode()); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getDescription() + */ + @Override + public String getDescription() { + return description; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getExecutionVariants() + */ + @Override + public synchronized Collection> getExecutionVariants() { + if (executionVariants == null) { + executionVariants = new LinkedList>(); + determineExecutionVariants(executionVariants); + } + + return executionVariants; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#geId() + */ + @Override + public int getId() { + return id; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getInstances() + */ + @Override + public Collection getInstances() { + return Collections.unmodifiableCollection(instances); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getType() + */ + @Override + public String getType() { + return type; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#hashCode() + */ + @Override + public synchronized int hashCode() { + return id; + } + + /** + * + */ + private boolean isSameExecution(ITaskInstance instance1, + ITaskInstance instance2) { + if (instance1 instanceof IIterationInstance) { + if (!(instance2 instanceof IIterationInstance)) { + return false; + } + + final ITaskInstanceList iteration1 = (ITaskInstanceList) instance1; + final ITaskInstanceList iteration2 = (ITaskInstanceList) instance2; + + return isSameExecutionList(iteration1, iteration2); + } else if (instance1 instanceof ISequenceInstance) { + if (!(instance2 instanceof ISequenceInstance)) { + return false; + } + + final ITaskInstanceList selection1 = (ITaskInstanceList) instance1; + final ITaskInstanceList selection2 = (ITaskInstanceList) instance2; + + return isSameExecutionList(selection1, selection2); + } else if (instance1 instanceof ISelectionInstance) { + if (!(instance2 instanceof ISelectionInstance)) { + return false; + } else { + return isSameExecution( + ((ISelectionInstance) instance1).getChild(), + ((ISelectionInstance) instance2).getChild()); + } + } else if (instance1 instanceof IOptionalInstance) { + if (!(instance2 instanceof IOptionalInstance)) { + return false; + } else { + return isSameExecution( + ((IOptionalInstance) instance1).getChild(), + ((IOptionalInstance) instance2).getChild()); + } + } else if (instance1 instanceof IEventTaskInstance) { + if (!(instance2 instanceof IEventTaskInstance)) { + return false; + } else { + return ((IEventTaskInstance) instance1).getTask().equals( + ((IEventTaskInstance) instance2).getTask()); + } + } else if (instance1 == null) { + return instance2 == null; + } else { + throw new IllegalArgumentException( + "unknown type of task instance: " + instance1); + } + } + + /** + * + */ + private boolean isSameExecutionList(ITaskInstanceList list1, + ITaskInstanceList list2) { + if (list1.size() == list2.size()) { + for (int i = 0; i < list1.size(); i++) { + if (!isSameExecution(list1.get(i), list2.get(i))) { + return false; + } + } + + return true; + } else { + return false; + } + } + + /** + *

+ * internally used to remove an instance from this task + *

+ * + * @param instance + * the instance to be removed from this task + */ + synchronized void removeInstance(ITaskInstance instance) { + this.instances.remove(instance); + this.executionVariants = null; + } + + /** + *

+ * internally used to set the human readable description of the task + *

+ * + * @param description + * the new human readable description of the task + */ + void setDescription(String description) { + this.description = description; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public synchronized String toString() { + final StringBuffer result = new StringBuffer(); + result.append(type); + result.append(" #"); + result.append(id); + + if (description != null) { + result.append(" ("); + result.append(description); + result.append(')'); + } + + return result.toString(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskBuilder.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskBuilder.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskBuilder.java (revision 1733) @@ -36,7 +36,8 @@ *

* this is the default implementation of the interface {@link ITaskBuilder}. It - * does not do anything fancy except implementing the interface. In some situations, it performs - * a check if the model or instances to be created a valid. However, this can not be done - * in any situation of the creation process. + * does not do anything fancy except implementing the interface. In some + * situations, it performs a check if the model or instances to be created a + * valid. However, this can not be done in any situation of the creation + * process. *

* @@ -45,506 +46,562 @@ public class TaskBuilder implements ITaskBuilder { - /* (non-Javadoc) - * @see ITaskBuilder#addChild(ISequenceInstance, ITaskInstance) - */ - @Override - public void addChild(ISequenceInstance instance, ITaskInstance child) - throws IllegalArgumentException - { - if (!(instance instanceof SequenceInstance)) { - throw new IllegalArgumentException - ("illegal type of sequence instance provided: " + instance.getClass()); - } - - if (!(child instanceof TaskInstance)) { - throw new IllegalArgumentException - ("illegal type of task instance provided: " + child.getClass()); - } - - SequenceInstance seqInstance = (SequenceInstance) instance; - - // check if new child instance matches the model, if this can be checked - IStructuringTemporalRelationship parentTask = - (IStructuringTemporalRelationship) instance.getTask(); - - if (((parentTask.getChildren() != null) && (parentTask.getChildren().size() > 0)) && - ((parentTask.getChildren().size() <= seqInstance.size()) || - (!parentTask.getChildren().get(seqInstance.size()).equals(child.getTask())))) - { - throw new IllegalArgumentException - ("the task of the child instance to be added does not belong to the children " + - "of the task of the parent instance"); - } - - seqInstance.addChild(child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#addChild(ISequenceInstance, int, ITaskInstance) - */ - public void addChild(ISequenceInstance instance, int index, ITaskInstance child) - throws IllegalArgumentException - { - if (!(instance instanceof SequenceInstance)) { - throw new IllegalArgumentException - ("illegal type of sequence instance provided: " + instance.getClass()); - } - - if (!(child instanceof TaskInstance)) { - throw new IllegalArgumentException - ("illegal type of task instance provided: " + child.getClass()); - } - - SequenceInstance seqInstance = (SequenceInstance) instance; - - // check if new child instance matches the model, if this can be checked - IStructuringTemporalRelationship parentTask = - (IStructuringTemporalRelationship) instance.getTask(); - - if (((parentTask.getChildren() != null) && (parentTask.getChildren().size() > 0)) && - ((parentTask.getChildren().size() <= index) || - (!parentTask.getChildren().get(index).equals(child.getTask())))) - { - throw new IllegalArgumentException - ("the task of the child instance to be added does not belong to the children " + - "of the task of the parent instance"); - } - - seqInstance.addChild(index, child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#addChild(IIterationInstance, ITaskInstance) - */ - @Override - public void addChild(IIterationInstance instance, ITaskInstance child) - throws IllegalArgumentException - { - if (!(instance instanceof IterationInstance)) { - throw new IllegalArgumentException - ("illegal type of iteration instance provided: " + instance.getClass()); - } - - if (!(child instanceof TaskInstance)) { - throw new IllegalArgumentException - ("illegal type of task instance provided: " + child.getClass()); - } - - // check if new child instance matches the model, if this can be checked - IMarkingTemporalRelationship parentTask = - (IMarkingTemporalRelationship) instance.getTask(); - - boolean foundChildTask = parentTask.getMarkedTask() != null ? - parentTask.getMarkedTask().equals(child.getTask()) : true; - - if (!foundChildTask) { - throw new IllegalArgumentException - ("the task of the child instance does not match the model of the task of the " + - "iteration instance: " + parentTask.getMarkedTask() + " <> " + child.getTask()); - } - - ((IterationInstance) instance).addChild(child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#addChild(IIterationInstance, int, ITaskInstance) - */ - public void addChild(IIterationInstance instance, int index, ITaskInstance child) - throws IllegalArgumentException - { - if (!(instance instanceof IterationInstance)) { - throw new IllegalArgumentException - ("illegal type of iteration instance provided: " + instance.getClass()); - } - - if (!(child instanceof TaskInstance)) { - throw new IllegalArgumentException - ("illegal type of task instance provided: " + child.getClass()); - } - - // check if new child instance matches the model, if this can be checked - IMarkingTemporalRelationship parentTask = - (IMarkingTemporalRelationship) instance.getTask(); - - boolean foundChildTask = parentTask.getMarkedTask() != null ? - parentTask.getMarkedTask().equals(child.getTask()) : true; - - if (!foundChildTask) { - throw new IllegalArgumentException - ("the task of the child instance does not match the model of the task of the " + - "iteration instance: " + parentTask.getMarkedTask() + " <> " + child.getTask()); - } - - ((IterationInstance) instance).addChild(index, child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#setChild(ISelectionInstance, ITaskInstance) - */ - @Override - public void setChild(ISelectionInstance instance, ITaskInstance child) - throws IllegalArgumentException - { - if (!(instance instanceof SelectionInstance)) { - throw new IllegalArgumentException - ("illegal type of selection instance provided: " + instance.getClass()); - } - - if (!(child instanceof TaskInstance)) { - throw new IllegalArgumentException("illegal type of task instance provided: " + - (child == null ? null : child.getClass())); - } - - // check if new child instance matches the model, if this can be checked - IStructuringTemporalRelationship parentTask = - (IStructuringTemporalRelationship) instance.getTask(); - - boolean foundChildTask = false; - for (ITask parentTaskChild : parentTask.getChildren()) { - if (parentTaskChild.equals(child.getTask())) { - foundChildTask = true; - break; - } - } - - if (!foundChildTask) { - throw new IllegalArgumentException - ("the task of the child instance to be added does not belong to the children " + - "of the selection task model of the parent instance"); - } - - ((SelectionInstance) instance).setChild(child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#setChild(IOptionalInstance, ITaskInstance) - */ - @Override - public void setChild(IOptionalInstance instance, ITaskInstance child) - throws IllegalArgumentException - { - if (!(instance instanceof OptionalInstance)) { - throw new IllegalArgumentException - ("illegal type of optional instance provided: " + instance.getClass()); - } - - if (!(child instanceof TaskInstance)) { - throw new IllegalArgumentException - ("illegal type of task instance provided: " + child.getClass()); - } - - // check if new child instance matches the model, if this can be checked - IMarkingTemporalRelationship parentTask = - (IMarkingTemporalRelationship) instance.getTask(); - - boolean foundChildTask = parentTask.getMarkedTask() != null ? - parentTask.getMarkedTask().equals(child.getTask()) : true; - - if (!foundChildTask) { - throw new IllegalArgumentException - ("the task of the child instance does not match the model of the task of the " + - "optional instance: " + parentTask.getMarkedTask() + " <> " + child.getTask()); - } - - ((OptionalInstance) instance).setChild(child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#addExecutedTask(IUserSession, ITaskInstance) - */ - @Override - public void addExecutedTask(IUserSession session, ITaskInstance taskInstance) { - if (!(session instanceof UserSession)) { - throw new IllegalArgumentException - ("illegal type of session provided: " + session.getClass()); - } - - if (!(taskInstance instanceof TaskInstance)) { - throw new IllegalArgumentException - ("illegal type of task instance provided: " + taskInstance.getClass()); - } - - ((UserSession) session).addExecutedTask(taskInstance); - } - - /* (non-Javadoc) - * @see ITaskBuilder#addExecutedTask(IUserSession, int, ITaskInstance) - */ - public void addExecutedTask(IUserSession session, int index, ITaskInstance taskInstance) { - if (!(session instanceof UserSession)) { - throw new IllegalArgumentException - ("illegal type of session provided: " + session.getClass()); - } - - if (!(taskInstance instanceof TaskInstance)) { - throw new IllegalArgumentException - ("illegal type of task instance provided: " + taskInstance.getClass()); - } - - ((UserSession) session).addExecutedTask(index, taskInstance); - } - - /* (non-Javadoc) - * @see ITaskBuilder#addTaskInstance(ITaskInstanceList, ITaskInstance) - */ - @Override - public void addTaskInstance(ITaskInstanceList taskInstanceList, ITaskInstance taskInstance) { - if (taskInstanceList instanceof SequenceInstance) { - addChild((SequenceInstance) taskInstanceList, taskInstance); - } - else if (taskInstanceList instanceof IterationInstance) { - addChild((IterationInstance) taskInstanceList, taskInstance); - } - else if (taskInstanceList instanceof UserSession) { - addExecutedTask((UserSession) taskInstanceList, taskInstance); - } - else { - throw new IllegalArgumentException - ("illegal type of task instance list provided: " + taskInstanceList.getClass()); - } - } - - /* (non-Javadoc) - * @see ITaskBuilder#addTaskInstance(ITaskInstanceList, int, ITaskInstance) - */ - @Override - public void addTaskInstance(ITaskInstanceList taskInstanceList, - int index, - ITaskInstance taskInstance) - { - if (taskInstanceList instanceof SequenceInstance) { - addChild((SequenceInstance) taskInstanceList, index, taskInstance); - } - else if (taskInstanceList instanceof IterationInstance) { - addChild((IterationInstance) taskInstanceList, index, taskInstance); - } - else if (taskInstanceList instanceof UserSession) { - addExecutedTask((UserSession) taskInstanceList, index, taskInstance); - } - else { - throw new IllegalArgumentException - ("illegal type of task instance list provided: " + taskInstanceList.getClass()); - } - } - - /* (non-Javadoc) - * @see ITaskBuilder#setTaskInstance(ITaskInstanceList, int, ITaskInstance) - */ - @Override - public void setTaskInstance(ITaskInstanceList taskInstanceList, - int index, - ITaskInstance taskInstance) - { - removeTaskInstance(taskInstanceList, index); - addTaskInstance(taskInstanceList, index, taskInstance); - } - - /* (non-Javadoc) - * @see ITaskBuilder#setTask(ITaskInstance, ITask) - */ - @Override - public void setTask(ITaskInstance taskInstance, ITask task) { - if (!(taskInstance instanceof TaskInstance)) { - throw new IllegalArgumentException - ("illegal type of task instance provided: " + taskInstance.getClass()); - } - if (!(task instanceof Task)) { - throw new IllegalArgumentException("illegal type of task provided: " + task.getClass()); - } - - if (((TaskInstance) taskInstance).getTask() instanceof Task) { - ((Task) ((TaskInstance) taskInstance).getTask()).removeInstance(taskInstance); - } - ((TaskInstance) taskInstance).setTask(task); - - ((Task) task).addInstance(taskInstance); - } - - /* (non-Javadoc) - * @see ITaskBuilder#addChild(ISequence, ITask) - */ - @Override - public void addChild(ISequence parent, ITask child) { - if (!(parent instanceof Sequence)) { - throw new IllegalArgumentException - ("illegal type of sequence provided: " + parent.getClass()); - } - - addChildInternal((Sequence) parent, -1, child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#addChild(ISequence, int, ITask) - */ - @Override - public void addChild(ISequence parent, int index, ITask child) { - if (!(parent instanceof Sequence)) { - throw new IllegalArgumentException - ("illegal type of sequence provided: " + parent.getClass()); - } - - addChildInternal((Sequence) parent, index, child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#setChild(ISequence, int, ITask) - */ - @Override - public void setChild(ISequence parent, int index, ITask child) { - if (!(parent instanceof Sequence)) { - throw new IllegalArgumentException - ("illegal type of sequence provided: " + parent.getClass()); - } - - ((Sequence) parent).removeChild(index); - addChildInternal((Sequence) parent, index, child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#addChild(ISelection, ITask) - */ - @Override - public void addChild(ISelection parent, ITask child) { - if (!(parent instanceof Selection)) { - throw new IllegalArgumentException - ("illegal type of selection provided: " + parent.getClass()); - } - - addChildInternal((Selection) parent, -1, child); - } - - /* (non-Javadoc) - * @see ITaskBuilder#setMarkedTask(IIteration, ITask) - */ - @Override - public void setMarkedTask(IIteration iteration, ITask newChild) { - if (!(iteration instanceof Iteration)) { - throw new IllegalArgumentException - ("illegal type of iteration provided: " + iteration.getClass()); - } - - if (!(newChild instanceof Task)) { - throw new IllegalArgumentException - ("illegal type of task provided: " + newChild.getClass()); - } - - ((Iteration) iteration).setMarkedTask(newChild); - } - - /* (non-Javadoc) - * @see ITaskTreeBuilder#setChild(IOptional, ITaskTreeNode) - */ - @Override - public void setMarkedTask(IOptional optional, ITask newChild) { - if (!(optional instanceof Optional)) { - throw new IllegalArgumentException - ("illegal type of optional provided: " + optional.getClass()); - } - - if (!(newChild instanceof Task)) { - throw new IllegalArgumentException - ("illegal type of task provided: " + newChild.getClass()); - } - - ((Optional) optional).setMarkedTask(newChild); - } - - /* (non-Javadoc) - * @see ITaskBuilder#removeChild(ISequence, int) - */ - @Override - public void removeChild(ISequence parent, int index) { - if (!(parent instanceof Sequence)) { - throw new IllegalArgumentException - ("illegal type of sequence provided: " + parent.getClass()); - } - - ((Sequence) parent).removeChild(index); - } - - /* (non-Javadoc) - * @see ITaskBuilder#removeChild(ISelection, ITask) - */ - @Override - public void removeChild(ISelection parent, ITask child) { - if (!(parent instanceof Selection)) { - throw new IllegalArgumentException - ("illegal type of selection provided: " + parent.getClass()); - } - - List children = parent.getChildren(); - - for (int i = 0; i < children.size(); i++) { - if ((children.get(i) == child) || - ((children.get(i) != null) && (children.get(i).equals(child)))) - { - ((Selection) parent).removeChild(i); - break; - } - } - } - - /* (non-Javadoc) - * @see ITaskBuilder#removeTaskInstance(ITaskInstanceList, int) - */ - @Override - public void removeTaskInstance(ITaskInstanceList taskInstanceList, int index) { - if (taskInstanceList instanceof SequenceInstance) { - ((SequenceInstance) taskInstanceList).removeChild(index); - } - else if (taskInstanceList instanceof IterationInstance) { - ((IterationInstance) taskInstanceList).removeChild(index); - } - else if (taskInstanceList instanceof UserSession) { - ((UserSession) taskInstanceList).removeExecutedTask(index); - } - else { - throw new IllegalArgumentException - ("illegal type of task instance list provided: " + taskInstanceList.getClass()); - } - } - - /* (non-Javadoc) - * @see ITaskTreeBuilder#replaceChild(ISelection, ITaskTreeNode, ITaskTreeNode) - */ - @Override - public void replaceChild(ISelection parent, ITask oldChild, ITask newChild) { - if (!(parent instanceof Selection)) { - throw new IllegalArgumentException - ("illegal type of selection provided: " + parent.getClass()); - } - - List children = parent.getChildren(); - - for (int i = 0; i < children.size(); i++) { - if ((children.get(i) == oldChild) || - ((children.get(i) != null) && (children.get(i).equals(oldChild)))) - { - ((Selection) parent).removeChild(i); - ((Selection) parent).addChild(i, newChild); - break; - } - } - } - - /** - *

- * internal convenience method for adding children to a structuring temporal relationship - * including a check for the child type. - *

- */ - private void addChildInternal(StructuringTemporalRelationship parent, int index, ITask child) { - if (!(child instanceof Task)) { - throw new IllegalArgumentException - ("illegal type of task provided: " + child.getClass()); - } - - if (index > -1) { - parent.addChild(index, child); - } - else { - parent.addChild(child); - } - } + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addChild(IIterationInstance, int, ITaskInstance) + */ + public void addChild(IIterationInstance instance, int index, + ITaskInstance child) throws IllegalArgumentException { + if (!(instance instanceof IterationInstance)) { + throw new IllegalArgumentException( + "illegal type of iteration instance provided: " + + instance.getClass()); + } + + if (!(child instanceof TaskInstance)) { + throw new IllegalArgumentException( + "illegal type of task instance provided: " + + child.getClass()); + } + + // check if new child instance matches the model, if this can be checked + final IMarkingTemporalRelationship parentTask = (IMarkingTemporalRelationship) instance + .getTask(); + + final boolean foundChildTask = parentTask.getMarkedTask() != null ? parentTask + .getMarkedTask().equals(child.getTask()) : true; + + if (!foundChildTask) { + throw new IllegalArgumentException( + "the task of the child instance does not match the model of the task of the " + + "iteration instance: " + + parentTask.getMarkedTask() + " <> " + + child.getTask()); + } + + ((IterationInstance) instance).addChild(index, child); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addChild(IIterationInstance, ITaskInstance) + */ + @Override + public void addChild(IIterationInstance instance, ITaskInstance child) + throws IllegalArgumentException { + if (!(instance instanceof IterationInstance)) { + throw new IllegalArgumentException( + "illegal type of iteration instance provided: " + + instance.getClass()); + } + + if (!(child instanceof TaskInstance)) { + throw new IllegalArgumentException( + "illegal type of task instance provided: " + + child.getClass()); + } + + // check if new child instance matches the model, if this can be checked + final IMarkingTemporalRelationship parentTask = (IMarkingTemporalRelationship) instance + .getTask(); + + final boolean foundChildTask = parentTask.getMarkedTask() != null ? parentTask + .getMarkedTask().equals(child.getTask()) : true; + + if (!foundChildTask) { + throw new IllegalArgumentException( + "the task of the child instance does not match the model of the task of the " + + "iteration instance: " + + parentTask.getMarkedTask() + " <> " + + child.getTask()); + } + + ((IterationInstance) instance).addChild(child); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addChild(ISelection, ITask) + */ + @Override + public void addChild(ISelection parent, ITask child) { + if (!(parent instanceof Selection)) { + throw new IllegalArgumentException( + "illegal type of selection provided: " + parent.getClass()); + } + + addChildInternal((Selection) parent, -1, child); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addChild(ISequence, int, ITask) + */ + @Override + public void addChild(ISequence parent, int index, ITask child) { + if (!(parent instanceof Sequence)) { + throw new IllegalArgumentException( + "illegal type of sequence provided: " + parent.getClass()); + } + + addChildInternal((Sequence) parent, index, child); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addChild(ISequence, ITask) + */ + @Override + public void addChild(ISequence parent, ITask child) { + if (!(parent instanceof Sequence)) { + throw new IllegalArgumentException( + "illegal type of sequence provided: " + parent.getClass()); + } + + addChildInternal((Sequence) parent, -1, child); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addChild(ISequenceInstance, int, ITaskInstance) + */ + public void addChild(ISequenceInstance instance, int index, + ITaskInstance child) throws IllegalArgumentException { + if (!(instance instanceof SequenceInstance)) { + throw new IllegalArgumentException( + "illegal type of sequence instance provided: " + + instance.getClass()); + } + + if (!(child instanceof TaskInstance)) { + throw new IllegalArgumentException( + "illegal type of task instance provided: " + + child.getClass()); + } + + final SequenceInstance seqInstance = (SequenceInstance) instance; + + // check if new child instance matches the model, if this can be checked + final IStructuringTemporalRelationship parentTask = (IStructuringTemporalRelationship) instance + .getTask(); + + if (((parentTask.getChildren() != null) && (parentTask.getChildren() + .size() > 0)) + && ((parentTask.getChildren().size() <= index) || (!parentTask + .getChildren().get(index).equals(child.getTask())))) { + throw new IllegalArgumentException( + "the task of the child instance to be added does not belong to the children " + + "of the task of the parent instance"); + } + + seqInstance.addChild(index, child); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addChild(ISequenceInstance, ITaskInstance) + */ + @Override + public void addChild(ISequenceInstance instance, ITaskInstance child) + throws IllegalArgumentException { + if (!(instance instanceof SequenceInstance)) { + throw new IllegalArgumentException( + "illegal type of sequence instance provided: " + + instance.getClass()); + } + + if (!(child instanceof TaskInstance)) { + throw new IllegalArgumentException( + "illegal type of task instance provided: " + + child.getClass()); + } + + final SequenceInstance seqInstance = (SequenceInstance) instance; + + // check if new child instance matches the model, if this can be checked + final IStructuringTemporalRelationship parentTask = (IStructuringTemporalRelationship) instance + .getTask(); + + if (((parentTask.getChildren() != null) && (parentTask.getChildren() + .size() > 0)) + && ((parentTask.getChildren().size() <= seqInstance.size()) || (!parentTask + .getChildren().get(seqInstance.size()) + .equals(child.getTask())))) { + throw new IllegalArgumentException( + "the task of the child instance to be added does not belong to the children " + + "of the task of the parent instance"); + } + + seqInstance.addChild(child); + } + + /** + *

+ * internal convenience method for adding children to a structuring temporal + * relationship including a check for the child type. + *

+ */ + private void addChildInternal(StructuringTemporalRelationship parent, + int index, ITask child) { + if (!(child instanceof Task)) { + throw new IllegalArgumentException( + "illegal type of task provided: " + child.getClass()); + } + + if (index > -1) { + parent.addChild(index, child); + } else { + parent.addChild(child); + } + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addExecutedTask(IUserSession, int, ITaskInstance) + */ + public void addExecutedTask(IUserSession session, int index, + ITaskInstance taskInstance) { + if (!(session instanceof UserSession)) { + throw new IllegalArgumentException( + "illegal type of session provided: " + session.getClass()); + } + + if (!(taskInstance instanceof TaskInstance)) { + throw new IllegalArgumentException( + "illegal type of task instance provided: " + + taskInstance.getClass()); + } + + ((UserSession) session).addExecutedTask(index, taskInstance); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addExecutedTask(IUserSession, ITaskInstance) + */ + @Override + public void addExecutedTask(IUserSession session, ITaskInstance taskInstance) { + if (!(session instanceof UserSession)) { + throw new IllegalArgumentException( + "illegal type of session provided: " + session.getClass()); + } + + if (!(taskInstance instanceof TaskInstance)) { + throw new IllegalArgumentException( + "illegal type of task instance provided: " + + taskInstance.getClass()); + } + + ((UserSession) session).addExecutedTask(taskInstance); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addTaskInstance(ITaskInstanceList, int, ITaskInstance) + */ + @Override + public void addTaskInstance(ITaskInstanceList taskInstanceList, int index, + ITaskInstance taskInstance) { + if (taskInstanceList instanceof SequenceInstance) { + addChild((SequenceInstance) taskInstanceList, index, taskInstance); + } else if (taskInstanceList instanceof IterationInstance) { + addChild((IterationInstance) taskInstanceList, index, taskInstance); + } else if (taskInstanceList instanceof UserSession) { + addExecutedTask((UserSession) taskInstanceList, index, taskInstance); + } else { + throw new IllegalArgumentException( + "illegal type of task instance list provided: " + + taskInstanceList.getClass()); + } + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#addTaskInstance(ITaskInstanceList, ITaskInstance) + */ + @Override + public void addTaskInstance(ITaskInstanceList taskInstanceList, + ITaskInstance taskInstance) { + if (taskInstanceList instanceof SequenceInstance) { + addChild((SequenceInstance) taskInstanceList, taskInstance); + } else if (taskInstanceList instanceof IterationInstance) { + addChild((IterationInstance) taskInstanceList, taskInstance); + } else if (taskInstanceList instanceof UserSession) { + addExecutedTask((UserSession) taskInstanceList, taskInstance); + } else { + throw new IllegalArgumentException( + "illegal type of task instance list provided: " + + taskInstanceList.getClass()); + } + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#removeChild(ISelection, ITask) + */ + @Override + public void removeChild(ISelection parent, ITask child) { + if (!(parent instanceof Selection)) { + throw new IllegalArgumentException( + "illegal type of selection provided: " + parent.getClass()); + } + + final List children = parent.getChildren(); + + for (int i = 0; i < children.size(); i++) { + if ((children.get(i) == child) + || ((children.get(i) != null) && (children.get(i) + .equals(child)))) { + ((Selection) parent).removeChild(i); + break; + } + } + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#removeChild(ISequence, int) + */ + @Override + public void removeChild(ISequence parent, int index) { + if (!(parent instanceof Sequence)) { + throw new IllegalArgumentException( + "illegal type of sequence provided: " + parent.getClass()); + } + + ((Sequence) parent).removeChild(index); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#removeTaskInstance(ITaskInstanceList, int) + */ + @Override + public void removeTaskInstance(ITaskInstanceList taskInstanceList, int index) { + if (taskInstanceList instanceof SequenceInstance) { + ((SequenceInstance) taskInstanceList).removeChild(index); + } else if (taskInstanceList instanceof IterationInstance) { + ((IterationInstance) taskInstanceList).removeChild(index); + } else if (taskInstanceList instanceof UserSession) { + ((UserSession) taskInstanceList).removeExecutedTask(index); + } else { + throw new IllegalArgumentException( + "illegal type of task instance list provided: " + + taskInstanceList.getClass()); + } + } + + /* + * (non-Javadoc) + * + * @see ITaskTreeBuilder#replaceChild(ISelection, ITaskTreeNode, + * ITaskTreeNode) + */ + @Override + public void replaceChild(ISelection parent, ITask oldChild, ITask newChild) { + if (!(parent instanceof Selection)) { + throw new IllegalArgumentException( + "illegal type of selection provided: " + parent.getClass()); + } + + final List children = parent.getChildren(); + + for (int i = 0; i < children.size(); i++) { + if ((children.get(i) == oldChild) + || ((children.get(i) != null) && (children.get(i) + .equals(oldChild)))) { + ((Selection) parent).removeChild(i); + ((Selection) parent).addChild(i, newChild); + break; + } + } + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#setChild(IOptionalInstance, ITaskInstance) + */ + @Override + public void setChild(IOptionalInstance instance, ITaskInstance child) + throws IllegalArgumentException { + if (!(instance instanceof OptionalInstance)) { + throw new IllegalArgumentException( + "illegal type of optional instance provided: " + + instance.getClass()); + } + + if (!(child instanceof TaskInstance)) { + throw new IllegalArgumentException( + "illegal type of task instance provided: " + + child.getClass()); + } + + // check if new child instance matches the model, if this can be checked + final IMarkingTemporalRelationship parentTask = (IMarkingTemporalRelationship) instance + .getTask(); + + final boolean foundChildTask = parentTask.getMarkedTask() != null ? parentTask + .getMarkedTask().equals(child.getTask()) : true; + + if (!foundChildTask) { + throw new IllegalArgumentException( + "the task of the child instance does not match the model of the task of the " + + "optional instance: " + + parentTask.getMarkedTask() + " <> " + + child.getTask()); + } + + ((OptionalInstance) instance).setChild(child); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#setChild(ISelectionInstance, ITaskInstance) + */ + @Override + public void setChild(ISelectionInstance instance, ITaskInstance child) + throws IllegalArgumentException { + if (!(instance instanceof SelectionInstance)) { + throw new IllegalArgumentException( + "illegal type of selection instance provided: " + + instance.getClass()); + } + + if (!(child instanceof TaskInstance)) { + throw new IllegalArgumentException( + "illegal type of task instance provided: " + + (child == null ? null : child.getClass())); + } + + // check if new child instance matches the model, if this can be checked + final IStructuringTemporalRelationship parentTask = (IStructuringTemporalRelationship) instance + .getTask(); + + boolean foundChildTask = false; + for (final ITask parentTaskChild : parentTask.getChildren()) { + if (parentTaskChild.equals(child.getTask())) { + foundChildTask = true; + break; + } + } + + if (!foundChildTask) { + throw new IllegalArgumentException( + "the task of the child instance to be added does not belong to the children " + + "of the selection task model of the parent instance"); + } + + ((SelectionInstance) instance).setChild(child); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#setChild(ISequence, int, ITask) + */ + @Override + public void setChild(ISequence parent, int index, ITask child) { + if (!(parent instanceof Sequence)) { + throw new IllegalArgumentException( + "illegal type of sequence provided: " + parent.getClass()); + } + + ((Sequence) parent).removeChild(index); + addChildInternal((Sequence) parent, index, child); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#setMarkedTask(IIteration, ITask) + */ + @Override + public void setMarkedTask(IIteration iteration, ITask newChild) { + if (!(iteration instanceof Iteration)) { + throw new IllegalArgumentException( + "illegal type of iteration provided: " + + iteration.getClass()); + } + + if (!(newChild instanceof Task)) { + throw new IllegalArgumentException( + "illegal type of task provided: " + newChild.getClass()); + } + + ((Iteration) iteration).setMarkedTask(newChild); + } + + /* + * (non-Javadoc) + * + * @see ITaskTreeBuilder#setChild(IOptional, ITaskTreeNode) + */ + @Override + public void setMarkedTask(IOptional optional, ITask newChild) { + if (!(optional instanceof Optional)) { + throw new IllegalArgumentException( + "illegal type of optional provided: " + optional.getClass()); + } + + if (!(newChild instanceof Task)) { + throw new IllegalArgumentException( + "illegal type of task provided: " + newChild.getClass()); + } + + ((Optional) optional).setMarkedTask(newChild); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#setTask(ITaskInstance, ITask) + */ + @Override + public void setTask(ITaskInstance taskInstance, ITask task) { + if (!(taskInstance instanceof TaskInstance)) { + throw new IllegalArgumentException( + "illegal type of task instance provided: " + + taskInstance.getClass()); + } + if (!(task instanceof Task)) { + throw new IllegalArgumentException( + "illegal type of task provided: " + task.getClass()); + } + + if (((TaskInstance) taskInstance).getTask() instanceof Task) { + ((Task) ((TaskInstance) taskInstance).getTask()) + .removeInstance(taskInstance); + } + ((TaskInstance) taskInstance).setTask(task); + + ((Task) task).addInstance(taskInstance); + } + + /* + * (non-Javadoc) + * + * @see ITaskBuilder#setTaskInstance(ITaskInstanceList, int, ITaskInstance) + */ + @Override + public void setTaskInstance(ITaskInstanceList taskInstanceList, int index, + ITaskInstance taskInstance) { + removeTaskInstance(taskInstanceList, index); + addTaskInstance(taskInstanceList, index, taskInstance); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskFactory.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskFactory.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskFactory.java (revision 1733) @@ -35,6 +35,6 @@ *

* this is the default implementation of the interface {@link ITaskFactory}. It - * does not do anything fancy except implementing the interface. It instantiates the other - * implementations of the tree ifc in this package. + * does not do anything fancy except implementing the interface. It instantiates + * the other implementations of the tree ifc in this package. *

* @@ -43,139 +43,165 @@ public class TaskFactory implements ITaskFactory { - /* (non-Javadoc) - * @see ITaskFactory#createNewEventTask(String) - */ - @Override - public IEventTask createNewEventTask(String description) { - return new EventTask(description); - } - - /* (non-Javadoc) - * @see ITaskFactory#createNewSequence() - */ - @Override - public ISequence createNewSequence() { - return new Sequence(); - } - - /* (non-Javadoc) - * @see ITaskFactory#createNewIteration() - */ - @Override - public IIteration createNewIteration() { - return new Iteration(); - } - - /* (non-Javadoc) - * @see ITaskFactory#createNewOptional() - */ - @Override - public IOptional createNewOptional() { - return new Optional(); - } - - /* (non-Javadoc) - * @see ITaskFactory#createNewSelection() - */ - @Override - public ISelection createNewSelection() { - return new Selection(); - } - - /* (non-Javadoc) - * @see ITaskFactory#createNewTaskInstance(IEventTask, Event) - */ - @Override - public IEventTaskInstance createNewTaskInstance(IEventTask task, Event event) { - if (!(task instanceof EventTask)) { - throw new IllegalArgumentException - ("illegal type of event task provided: " + task.getClass()); - } - - EventTaskInstance instance = new EventTaskInstance(task, event); - ((EventTask) task).addInstance(instance); - - return instance; - } - - /* (non-Javadoc) - * @see ITaskFactory#createNewTaskInstance(ISequence) - */ - @Override - public ISequenceInstance createNewTaskInstance(ISequence sequence) { - if (!(sequence instanceof Sequence)) { - throw new IllegalArgumentException - ("illegal type of sequence provided: " + sequence.getClass()); - } - - SequenceInstance instance = new SequenceInstance(sequence); - ((Sequence) sequence).addInstance(instance); - - return instance; - } - - /* (non-Javadoc) - * @see ITaskFactory#createNewTaskInstance(IIteration) - */ - @Override - public IIterationInstance createNewTaskInstance(IIteration iteration) { - if (!(iteration instanceof Iteration)) { - throw new IllegalArgumentException - ("illegal type of iteration provided: " + iteration.getClass()); - } - - IterationInstance instance = new IterationInstance(iteration); - ((Iteration) iteration).addInstance(instance); - - return instance; - } - - /* (non-Javadoc) - * @see ITaskFactory#createNewTaskInstance(IOptional) - */ - @Override - public IOptionalInstance createNewTaskInstance(IOptional optional) { - if (!(optional instanceof Optional)) { - throw new IllegalArgumentException - ("illegal type of optional provided: " + optional.getClass()); - } - - OptionalInstance instance = new OptionalInstance(optional); - ((Optional) optional).addInstance(instance); - - return instance; - } - - /* (non-Javadoc) - * @see ITaskFactory#createNewTaskInstance(ISelection) - */ - @Override - public ISelectionInstance createNewTaskInstance(ISelection selection) { - if (!(selection instanceof Selection)) { - throw new IllegalArgumentException - ("illegal type of optional provided: " + selection.getClass()); - } - - SelectionInstance instance = new SelectionInstance(selection); - ((Selection) selection).addInstance(instance); - - return instance; - } - - /* (non-Javadoc) - * @see ITaskFactory#createUserSession() - */ - @Override - public IUserSession createUserSession() { - return new UserSession(); - } - - /* (non-Javadoc) - * @see ITaskFactory#createTaskModel(List) - */ - @Override - public ITaskModel createTaskModel(List userSessions) { - return new TaskModel(userSessions); - } + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewEventTask(String) + */ + @Override + public IEventTask createNewEventTask(String description) { + return new EventTask(description); + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewIteration() + */ + @Override + public IIteration createNewIteration() { + return new Iteration(); + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewOptional() + */ + @Override + public IOptional createNewOptional() { + return new Optional(); + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewSelection() + */ + @Override + public ISelection createNewSelection() { + return new Selection(); + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewSequence() + */ + @Override + public ISequence createNewSequence() { + return new Sequence(); + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewTaskInstance(IEventTask, Event) + */ + @Override + public IEventTaskInstance createNewTaskInstance(IEventTask task, Event event) { + if (!(task instanceof EventTask)) { + throw new IllegalArgumentException( + "illegal type of event task provided: " + task.getClass()); + } + + final EventTaskInstance instance = new EventTaskInstance(task, event); + ((EventTask) task).addInstance(instance); + + return instance; + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewTaskInstance(IIteration) + */ + @Override + public IIterationInstance createNewTaskInstance(IIteration iteration) { + if (!(iteration instanceof Iteration)) { + throw new IllegalArgumentException( + "illegal type of iteration provided: " + + iteration.getClass()); + } + + final IterationInstance instance = new IterationInstance(iteration); + ((Iteration) iteration).addInstance(instance); + + return instance; + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewTaskInstance(IOptional) + */ + @Override + public IOptionalInstance createNewTaskInstance(IOptional optional) { + if (!(optional instanceof Optional)) { + throw new IllegalArgumentException( + "illegal type of optional provided: " + optional.getClass()); + } + + final OptionalInstance instance = new OptionalInstance(optional); + ((Optional) optional).addInstance(instance); + + return instance; + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewTaskInstance(ISelection) + */ + @Override + public ISelectionInstance createNewTaskInstance(ISelection selection) { + if (!(selection instanceof Selection)) { + throw new IllegalArgumentException( + "illegal type of optional provided: " + + selection.getClass()); + } + + final SelectionInstance instance = new SelectionInstance(selection); + ((Selection) selection).addInstance(instance); + + return instance; + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createNewTaskInstance(ISequence) + */ + @Override + public ISequenceInstance createNewTaskInstance(ISequence sequence) { + if (!(sequence instanceof Sequence)) { + throw new IllegalArgumentException( + "illegal type of sequence provided: " + sequence.getClass()); + } + + final SequenceInstance instance = new SequenceInstance(sequence); + ((Sequence) sequence).addInstance(instance); + + return instance; + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createTaskModel(List) + */ + @Override + public ITaskModel createTaskModel(List userSessions) { + return new TaskModel(userSessions); + } + + /* + * (non-Javadoc) + * + * @see ITaskFactory#createUserSession() + */ + @Override + public IUserSession createUserSession() { + return new UserSession(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskInfo.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskInfo.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskInfo.java (revision 1733) @@ -31,273 +31,310 @@ */ public class TaskInfo implements ITaskInfo { - - /** - *

- * the task to which the infos belong - *

- */ - private ITask task; - - /** - *

- * all available measures for the task - *

- */ - private ArrayList measures = new ArrayList(); - - /** - *

- * initialized the task infos with the task to which they belong. - *

- * - * @param task - */ - TaskInfo(ITask task) { - this.task = task; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo#getTask() - */ - @Override - public ITask getTask() { - return task; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo#getMeasures() - */ - @Override - public IMeasure[] getMeasures() { - measures.trimToSize(); - return measures.toArray(new IMeasure[measures.size()]); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo#getMeasureValue(java.lang.String) - */ - @Override - public int getMeasureValue(TaskMetric metric) { - Measure measure = getMeasure(metric); - - if (measure == null) { - throw new IllegalArgumentException("unknown metric " + metric); - } - - return measure.getValue(); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo#getMeasureValue(java.lang.String, de.ugoe.cs.autoquest.tasktrees.treeifc.ITask) - */ - @Override - public int getMeasureValue(TaskMetric metric, ITask context) { - Measure measure = getMeasure(metric); - - if (measure == null) { - throw new IllegalArgumentException("unknown metric " + metric); - } - - return measure.getValue(context); - } - - /* (non-Javadoc) - * @see java.lang.Object#toString() - */ - @Override - public synchronized String toString() { - return "TaskInfo(" + task + ")"; - } - - /** - *

- * must be called to indicate that a new new measures for the provided metric are about to - * be calculated and added. - *

- * - * @param metric the metric for which measures are about to be provided - */ - void addMeasure(TaskMetric metric) { - Measure measure = getMeasure(metric); - - if (measure != null) { - throw new IllegalArgumentException("measure for metric " + metric + " already exists."); - } - - measure = new Measure(metric); - measures.add(measure); - } - - /** - *

- * sets a specific value for a measure of a specific metric in the provided context of the task - *

- * - * @param metric the metric to which the value belongs - * @param context the context of the task in which the measure was recorded - * @param value the value of the measure - */ - void setCount(TaskMetric metric, ITask context, int value) { - Measure measure = getMeasure(metric); - - if (measure == null) { - throw new IllegalArgumentException("unknown metric. Please create a measure " + - "for the metric before using it."); - } - - measure.set(context, value); - } - - /** - *

- * increases a specific value for a measure of a specific metric in the provided context of the - * task - *

- * - * @param metric the metric to which the value belongs - * @param context the context of the task in which the measure was recorded - * @param increment the increment to be added to the value of the measure - */ - void increaseCount(TaskMetric metric, ITask context, int increment) { - Measure measure = getMeasure(metric); - - if (measure == null) { - throw new IllegalArgumentException("unknown metric. Please create a measure " + - "for the metric before using it."); - } - - measure.increase(context, increment); - } - - /** - *

- * convenience method to internally determine the measure for a specific metric - *

- */ - private Measure getMeasure(TaskMetric metric) { - for (Measure candidate : measures) { - if (candidate.getMetric().equals(metric)) { - return candidate; - } - } - - return null; - } - - /** - *

- * implementation for the measure interface of the task info interface. Does nothing fancy - * except implementing the interface - *

- * - * @author Patrick Harms - */ - private static class Measure implements IMeasure { - - /** - *

- * the metric to which the measure belongs - *

- */ - private TaskMetric metric; - - /** - *

- * the observed values for the difference contexts of the task - *

- */ - private HashMap values; - - /** - *

- * the context free value of the measure independent of the task context - *

- */ - private int contextFreeValue = 0; - - /** - *

- * initializes the measure with a specific metric - *

- */ - private Measure(TaskMetric metric) { - super(); - this.metric = metric; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo.IMeasure#getMetric() - */ - @Override - public TaskMetric getMetric() { - return metric; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo.IMeasure#getValue() - */ - @Override - public int getValue() { - return contextFreeValue; - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo.IMeasure#getValue(de.ugoe.cs.autoquest.tasktrees.treeifc.ITask) - */ - @Override - public int getValue(ITask context) { - if ((context != null) && (values != null)) { - Integer currentValue = values.get(context); - - if (currentValue != null) { - return currentValue; - } - } - - return Integer.MIN_VALUE; - } - - /** - *

- * sets the value of the measure context free as well as specific to the provided context - *

- */ - private void set(ITask context, int value) { - contextFreeValue = value; - - if (context != null) { - if (values == null) { - values = new HashMap(); - } - - values.put(context, value); - } - } - - /** - *

- * increases the value of the measure context free as well as specific to the provided - * context according to the provided increment - *

- */ - private void increase(ITask context, int increment) { - contextFreeValue += increment; - - if (context != null) { - if (values == null) { - values = new HashMap(); - } - - Integer currentValue = values.get(context); - - if (currentValue == null) { - currentValue = 0; - } - - values.put(context, currentValue + increment); - } - } - - } + + /** + *

+ * implementation for the measure interface of the task info interface. Does + * nothing fancy except implementing the interface + *

+ * + * @author Patrick Harms + */ + private static class Measure implements IMeasure { + + /** + *

+ * the metric to which the measure belongs + *

+ */ + private final TaskMetric metric; + + /** + *

+ * the observed values for the difference contexts of the task + *

+ */ + private HashMap values; + + /** + *

+ * the context free value of the measure independent of the task context + *

+ */ + private int contextFreeValue = 0; + + /** + *

+ * initializes the measure with a specific metric + *

+ */ + private Measure(TaskMetric metric) { + super(); + this.metric = metric; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo.IMeasure#getMetric() + */ + @Override + public TaskMetric getMetric() { + return metric; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo.IMeasure#getValue() + */ + @Override + public int getValue() { + return contextFreeValue; + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo.IMeasure#getValue + * (de.ugoe.cs.autoquest.tasktrees.treeifc.ITask) + */ + @Override + public int getValue(ITask context) { + if ((context != null) && (values != null)) { + final Integer currentValue = values.get(context); + + if (currentValue != null) { + return currentValue; + } + } + + return Integer.MIN_VALUE; + } + + /** + *

+ * increases the value of the measure context free as well as specific + * to the provided context according to the provided increment + *

+ */ + private void increase(ITask context, int increment) { + contextFreeValue += increment; + + if (context != null) { + if (values == null) { + values = new HashMap(); + } + + Integer currentValue = values.get(context); + + if (currentValue == null) { + currentValue = 0; + } + + values.put(context, currentValue + increment); + } + } + + /** + *

+ * sets the value of the measure context free as well as specific to the + * provided context + *

+ */ + private void set(ITask context, int value) { + contextFreeValue = value; + + if (context != null) { + if (values == null) { + values = new HashMap(); + } + + values.put(context, value); + } + } + + } + + /** + *

+ * the task to which the infos belong + *

+ */ + private final ITask task; + + /** + *

+ * all available measures for the task + *

+ */ + private final ArrayList measures = new ArrayList(); + + /** + *

+ * initialized the task infos with the task to which they belong. + *

+ * + * @param task + */ + TaskInfo(ITask task) { + this.task = task; + } + + /** + *

+ * must be called to indicate that a new new measures for the provided + * metric are about to be calculated and added. + *

+ * + * @param metric + * the metric for which measures are about to be provided + */ + void addMeasure(TaskMetric metric) { + Measure measure = getMeasure(metric); + + if (measure != null) { + throw new IllegalArgumentException("measure for metric " + metric + + " already exists."); + } + + measure = new Measure(metric); + measures.add(measure); + } + + /** + *

+ * convenience method to internally determine the measure for a specific + * metric + *

+ */ + private Measure getMeasure(TaskMetric metric) { + for (final Measure candidate : measures) { + if (candidate.getMetric().equals(metric)) { + return candidate; + } + } + + return null; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo#getMeasures() + */ + @Override + public IMeasure[] getMeasures() { + measures.trimToSize(); + return measures.toArray(new IMeasure[measures.size()]); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo#getMeasureValue(java + * .lang.String) + */ + @Override + public int getMeasureValue(TaskMetric metric) { + final Measure measure = getMeasure(metric); + + if (measure == null) { + throw new IllegalArgumentException("unknown metric " + metric); + } + + return measure.getValue(); + } + + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo#getMeasureValue(java + * .lang.String, de.ugoe.cs.autoquest.tasktrees.treeifc.ITask) + */ + @Override + public int getMeasureValue(TaskMetric metric, ITask context) { + final Measure measure = getMeasure(metric); + + if (measure == null) { + throw new IllegalArgumentException("unknown metric " + metric); + } + + return measure.getValue(context); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInfo#getTask() + */ + @Override + public ITask getTask() { + return task; + } + + /** + *

+ * increases a specific value for a measure of a specific metric in the + * provided context of the task + *

+ * + * @param metric + * the metric to which the value belongs + * @param context + * the context of the task in which the measure was recorded + * @param increment + * the increment to be added to the value of the measure + */ + void increaseCount(TaskMetric metric, ITask context, int increment) { + final Measure measure = getMeasure(metric); + + if (measure == null) { + throw new IllegalArgumentException( + "unknown metric. Please create a measure " + + "for the metric before using it."); + } + + measure.increase(context, increment); + } + + /** + *

+ * sets a specific value for a measure of a specific metric in the provided + * context of the task + *

+ * + * @param metric + * the metric to which the value belongs + * @param context + * the context of the task in which the measure was recorded + * @param value + * the value of the measure + */ + void setCount(TaskMetric metric, ITask context, int value) { + final Measure measure = getMeasure(metric); + + if (measure == null) { + throw new IllegalArgumentException( + "unknown metric. Please create a measure " + + "for the metric before using it."); + } + + measure.set(context, value); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public synchronized String toString() { + return "TaskInfo(" + task + ")"; + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskInstance.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskInstance.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskInstance.java (revision 1733) @@ -28,149 +28,166 @@ */ class TaskInstance implements ITaskInstance { - - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; - /** - *

- * used as a counter to generate new ids for each newly created task instance. May overflow. - *

- */ - private static int temporalId = 0; + /** + *

+ * creates a new id for a task instance using {@link #temporalId} by + * incrementing it an returning its current value. Resets the counter if + * {@link Integer.MAX_VALUE} is reached. + *

+ * + * @return a new unique id for a task instance as long as + * {@link #temporalId} does not overflow + */ + private static synchronized int getNewId() { + if (temporalId == Integer.MAX_VALUE) { + temporalId = 0; + } - /** - *

- * the task instantiated by this task instance - *

- */ - private ITask task; - - /** - *

- * the id of the task instance (unique throughout the system as long as {@link #temporalId} - * does not overflow. - *

- */ - private int id; + return temporalId++; + } - /** - *

- * instantiated the task instance with the task that is instantiated by the instance. It also - * assigns a unique id to the instance using {@link #getNewId()}. - *

- */ - TaskInstance(ITask task) { - this.task = task; - id = getNewId(); - } + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /** - *

- * creates a new id for a task instance using {@link #temporalId} by incrementing it an - * returning its current value. Resets the counter if {@link Integer.MAX_VALUE} is reached. - *

- * - * @return a new unique id for a task instance as long as {@link #temporalId} does not overflow - */ - private static synchronized int getNewId() { - if (temporalId == Integer.MAX_VALUE) { - temporalId = 0; - } + /** + *

+ * used as a counter to generate new ids for each newly created task + * instance. May overflow. + *

+ */ + private static int temporalId = 0; - return temporalId++; - } + /** + *

+ * the task instantiated by this task instance + *

+ */ + private ITask task; - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance#getTask() - */ - @Override - public ITask getTask() { - return task; - } + /** + *

+ * the id of the task instance (unique throughout the system as long as + * {@link #temporalId} does not overflow. + *

+ */ + private final int id; - /* - * (non-Javadoc) - * - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskTreeNode#equals(TaskTreeNode) - */ - @Override - public boolean equals(ITaskInstance taskInstance) { - // task instances are only equal if they are identical or if they have the same id - // (may happen, if they are cloned) - return (this == taskInstance) || (this.hashCode() == taskInstance.hashCode()); - } + /** + *

+ * instantiated the task instance with the task that is instantiated by the + * instance. It also assigns a unique id to the instance using + * {@link #getNewId()}. + *

+ */ + TaskInstance(ITask task) { + this.task = task; + id = getNewId(); + } - /* (non-Javadoc) - * @see java.lang.Object#hashCode() - */ - @Override - public synchronized int hashCode() { - return id; - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance#accept( + * ITaskInstanceVisitor) + */ + @Override + public void accept(ITaskInstanceVisitor visitor) { + visitor.visit(this); + } - /* (non-Javadoc) - * @see java.lang.Object#toString() - */ - @Override - public synchronized String toString() { - StringBuffer result = new StringBuffer(); - result.append(task.getType()); - result.append(" #"); - result.append(task.getId()); - - if (task.getDescription() != null) { - result.append(" ("); - result.append(task.getDescription()); - result.append(')'); - } - - /*if (children != null) { - result.append(", "); - result.append(children.size()); - result.append(" children"); - }*/ - - return result.toString(); - } + /* + * (non-Javadoc) + * + * @see java.lang.Object#clone() + */ + @Override + public synchronized ITaskInstance clone() { + TaskInstance clone = null; + try { + clone = (TaskInstance) super.clone(); + } catch (final CloneNotSupportedException e) { + // this should never happen. Therefore simply dump the exception + e.printStackTrace(); + } - /* (non-Javadoc) - * @see java.lang.Object#clone() - */ - @Override - public synchronized ITaskInstance clone() { - TaskInstance clone = null; - try { - clone = (TaskInstance) super.clone(); - } - catch (CloneNotSupportedException e) { - // this should never happen. Therefore simply dump the exception - e.printStackTrace(); - } + return clone; + } - return clone; - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.TaskTreeNode#equals(TaskTreeNode) + */ + @Override + public boolean equals(ITaskInstance taskInstance) { + // task instances are only equal if they are identical or if they have + // the same id + // (may happen, if they are cloned) + return (this == taskInstance) + || (this.hashCode() == taskInstance.hashCode()); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance#accept(ITaskInstanceVisitor) - */ - @Override - public void accept(ITaskInstanceVisitor visitor) { - visitor.visit(this); - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstance#getTask() + */ + @Override + public ITask getTask() { + return task; + } - /** - *

- * used to update the task represented through this instance - *

- * - * @param task the task to set - */ - void setTask(ITask task) { - this.task = task; - } + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public synchronized int hashCode() { + return id; + } + + /** + *

+ * used to update the task represented through this instance + *

+ * + * @param task + * the task to set + */ + void setTask(ITask task) { + this.task = task; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public synchronized String toString() { + final StringBuffer result = new StringBuffer(); + result.append(task.getType()); + result.append(" #"); + result.append(task.getId()); + + if (task.getDescription() != null) { + result.append(" ("); + result.append(task.getDescription()); + result.append(')'); + } + + /* + * if (children != null) { result.append(", "); + * result.append(children.size()); result.append(" children"); } + */ + + return result.toString(); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskModel.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskModel.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/TaskModel.java (revision 1733) @@ -43,6 +43,7 @@ *

* this is the default implementation of the interface {@link ITaskModel}. It - * does not do anything fancy except implementing the interface. It also calculates on - * initialisations the measures for diverse metrics of the task belonging to the model + * does not do anything fancy except implementing the interface. It also + * calculates on initialisations the measures for diverse metrics of the task + * belonging to the model *

* @@ -50,344 +51,360 @@ */ class TaskModel implements ITaskModel { - - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; - - /** - *

- * all metrics calculated by this type of task model - *

- */ - private static final TaskMetric[] taskMetrics = new TaskMetric[] - { TaskMetric.COUNT, - TaskMetric.DEPTH, - TaskMetric.EVENT_COVERAGE, - TaskMetric.EVENT_COVERAGE_RATIO, - TaskMetric.EVENT_COVERAGE_QUANTILE }; - - /** - *

- * the user sessions belonging to the model - *

- */ - private List userSessions; - - /** - *

- * index for effectively accessing the model and calculating statistics about it - *

- */ - private transient TaskModelIndex index = null; - - /** - *

- * initializes the task model with the user sessions out of which the tasks are extracted - *

- * - * @param userSessions as described - */ - TaskModel(List userSessions) { - if ((userSessions == null) || (userSessions.size() == 0)) { - throw new IllegalArgumentException("user sessions must not be null"); - } - - this.userSessions = userSessions; - } - - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel#getUserSessions() - */ - @Override - public List getUserSessions() { - ensureInitialized(); - return Collections.unmodifiableList(userSessions); - } - - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel#getTasks() - */ - @Override - public Collection getTasks() { - ensureInitialized(); - return Collections.unmodifiableCollection(index.taskMap.keySet()); - } - - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel#getTaskInfo(ITask) - */ - @Override - public ITaskInfo getTaskInfo(ITask task) { - ensureInitialized(); - return index.taskMap.get(task); - } - - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel#getAllMetrics() - */ - @Override - public TaskMetric[] getAllMetrics() { - return taskMetrics; - } - - - /* (non-Javadoc) - * @see java.lang.Object#clone() - */ - @Override - public TaskModel clone() { - return new TaskModel(userSessions); - } - - /** - *

- * internal convenience method that initializes the internal index and calculates all measures - * for metrics available for the tasks - *

- */ - private synchronized void ensureInitialized() { - if (index == null) { - index = new TaskModelIndex(); - - for (IUserSession session : this.userSessions) { - for (ITaskInstance taskInstance : session) { - index.handleTaskInstance(taskInstance, null); - } - } - - // count all events covered - int allEventsCovered = 0; - Collection tasks = getTasks(); - for (ITask task : tasks) { - if (task instanceof IEventTask) { - allEventsCovered += task.getInstances().size(); - } - } - - int[] eventCoverageRatios = new int[tasks.size()]; - int i = 0; - - // add some further measures - for (ITask task : tasks) { - TaskInfo info = index.taskMap.get(task); - info.addMeasure(TaskMetric.EVENT_COVERAGE_RATIO); - - int coveredEvents = info.getMeasureValue(TaskMetric.EVENT_COVERAGE); - int coverageRatio = 0; - - if (allEventsCovered > 0) { - coverageRatio = (coveredEvents * 1000) / allEventsCovered; - } - - eventCoverageRatios[i++] = coverageRatio; - info.setCount(TaskMetric.EVENT_COVERAGE_RATIO, null, coverageRatio); - } - - Arrays.sort(eventCoverageRatios); - - // add some further measures - for (ITask task : tasks) { - TaskInfo info = index.taskMap.get(task); - info.addMeasure(TaskMetric.EVENT_COVERAGE_QUANTILE); - int quantile = Arrays.binarySearch - (eventCoverageRatios, info.getMeasureValue(TaskMetric.EVENT_COVERAGE_RATIO)); - - quantile = 1000 * quantile / eventCoverageRatios.length; - - info.setCount(TaskMetric.EVENT_COVERAGE_QUANTILE, null, quantile); - } - - //index.dumpToCSV(System.out); - /*try { - OutputStream stream = new FileOutputStream(new File("tasks.csv")); - index.dumpToCSV(new PrintStream(stream)); - stream.close(); - } - catch (FileNotFoundException e) { - e.printStackTrace(); - }*/ - } - - } - - /** - *

- * the index of task infos used internally. The index is created once and while that filled - * with task infos for each observed task containing all measures for metrics belonging - * to the tasks. - *

- * - * @author Patrick Harms - */ - private static class TaskModelIndex { - - /** - *

- * the tasks contained in the user session belonging to the model as well as statistical - * infos about them - *

- */ - private Map taskMap = new HashMap(); - - /** - *

- * called on initialization to fill the index with infos about the given task instance - * as well as to calculate the appropriate metrics - *

- */ - private int[] handleTaskInstance(ITaskInstance taskInstance, ITask context) { - int eventTaskInstancesCovered = 0; - int depth = 0; - - if (taskInstance instanceof ITaskInstanceList) { - for (ITaskInstance child : (ITaskInstanceList) taskInstance) { - int[] measures = handleTaskInstance(child, taskInstance.getTask()); - eventTaskInstancesCovered += measures[0]; - depth = Math.max(depth, measures[1]); - } - - if ((((ITaskInstanceList) taskInstance).size() == 0) && - (taskInstance instanceof IIterationInstance)) - { - // ensure also empty task infos for unselected variants - ensureTaskInfo(((IIteration) taskInstance.getTask()).getMarkedTask(), context); - } - } - else if (taskInstance instanceof ISelectionInstance) { - ITaskInstance child = ((ISelectionInstance) taskInstance).getChild(); - int[] measures = handleTaskInstance(child, taskInstance.getTask()); - eventTaskInstancesCovered += measures[0]; - depth = Math.max(depth, measures[1]); - - // ensure also empty task infos for unselected variants - for (ITask otherChildTask : ((ISelection) taskInstance.getTask()).getChildren()) { - ensureTaskInfo(otherChildTask, context); - } - } - else if (taskInstance instanceof IOptionalInstance) { - ITaskInstance child = ((IOptionalInstance) taskInstance).getChild(); - if (child != null) { - int[] measures = handleTaskInstance(child, taskInstance.getTask()); - eventTaskInstancesCovered += measures[0]; - depth = Math.max(depth, measures[1]); - } - else { - // ensure also empty task infos for unselected variants - ensureTaskInfo(((IOptional) taskInstance.getTask()).getMarkedTask(), context); - } - } - else if (taskInstance instanceof IEventTaskInstance) { - eventTaskInstancesCovered = 1; - } - - depth++; - - ensureTaskInfo(taskInstance.getTask(), context, eventTaskInstancesCovered, depth); - - return new int[] { eventTaskInstancesCovered, depth }; - } - - /** - *

- * internal convenience method to build the task model during initialization - *

- */ - private void ensureTaskInfo(ITask task, ITask context) { - ensureTaskInfo(task, context, 0, 0); - - if (task instanceof IStructuringTemporalRelationship) { - for (ITask child : ((IStructuringTemporalRelationship) task).getChildren()) { - ensureTaskInfo(child, task); - } - } - else if (task instanceof IMarkingTemporalRelationship) { - ensureTaskInfo(((IMarkingTemporalRelationship) task).getMarkedTask(), task); - } - - } - - /** - *

- * internal convenience method to build the task model during initialization. Adds a new - * task info object to the map for the provided task and fills it with measures. If there - * are already some task infos for the task, the contained measures are updated according - * to the parameters. - *

- */ - private void ensureTaskInfo(ITask task, - ITask context, - int eventTaskInstancesCovered, - int depth) - { - TaskInfo taskInfo = taskMap.get(task); - - if (taskInfo == null) { - taskInfo = new TaskInfo(task); - taskInfo.addMeasure(TaskMetric.COUNT); - taskInfo.addMeasure(TaskMetric.EVENT_COVERAGE); - taskInfo.addMeasure(TaskMetric.DEPTH); - taskMap.put(task, taskInfo); - - taskInfo.setCount(TaskMetric.DEPTH, null, getDepth(task)); - } - - taskInfo.increaseCount(TaskMetric.COUNT, context, 1); - taskInfo.increaseCount(TaskMetric.EVENT_COVERAGE, context, eventTaskInstancesCovered); - - taskInfo.setCount(TaskMetric.DEPTH, context, depth); - } - - /** - *

- * internal convenience method to calculate the maximum depth of a task - *

- */ - private int getDepth(ITask task) { - if (task instanceof IMarkingTemporalRelationship) { - return getDepth(((IMarkingTemporalRelationship) task).getMarkedTask()) + 1; - } - else if (task instanceof IStructuringTemporalRelationship) { - int maxDepth = 0; - - for (ITask child : ((IStructuringTemporalRelationship) task).getChildren()) { - maxDepth = Math.max(maxDepth, getDepth(child)); - } - - return maxDepth + 1; - } - else { - // event tasks - return 1; - } - } - - /** - * - */ - /*private void dumpToCSV(PrintStream out) { - out.println("taskid;depth;count;eventcoverage;eventcoverageratio"); - - for (Map.Entry entry : taskMap.entrySet()) { - out.print(entry.getKey().getId()); - out.print(';'); - out.print(entry.getValue().getMeasureValue(TaskMetric.DEPTH)); - out.print(';'); - out.print(entry.getValue().getMeasureValue(TaskMetric.COUNT)); - out.print(';'); - out.print(entry.getValue().getMeasureValue(TaskMetric.EVENT_COVERAGE)); - out.print(';'); - out.print(entry.getValue().getMeasureValue(TaskMetric.EVENT_COVERAGE_RATIO)); - out.println(); - } - }*/ - - } - + + /** + *

+ * the index of task infos used internally. The index is created once and + * while that filled with task infos for each observed task containing all + * measures for metrics belonging to the tasks. + *

+ * + * @author Patrick Harms + */ + private static class TaskModelIndex { + + /** + *

+ * the tasks contained in the user session belonging to the model as + * well as statistical infos about them + *

+ */ + private final Map taskMap = new HashMap(); + + /** + *

+ * internal convenience method to build the task model during + * initialization + *

+ */ + private void ensureTaskInfo(ITask task, ITask context) { + ensureTaskInfo(task, context, 0, 0); + + if (task instanceof IStructuringTemporalRelationship) { + for (final ITask child : ((IStructuringTemporalRelationship) task) + .getChildren()) { + ensureTaskInfo(child, task); + } + } else if (task instanceof IMarkingTemporalRelationship) { + ensureTaskInfo( + ((IMarkingTemporalRelationship) task).getMarkedTask(), + task); + } + + } + + /** + *

+ * internal convenience method to build the task model during + * initialization. Adds a new task info object to the map for the + * provided task and fills it with measures. If there are already some + * task infos for the task, the contained measures are updated according + * to the parameters. + *

+ */ + private void ensureTaskInfo(ITask task, ITask context, + int eventTaskInstancesCovered, int depth) { + TaskInfo taskInfo = taskMap.get(task); + + if (taskInfo == null) { + taskInfo = new TaskInfo(task); + taskInfo.addMeasure(TaskMetric.COUNT); + taskInfo.addMeasure(TaskMetric.EVENT_COVERAGE); + taskInfo.addMeasure(TaskMetric.DEPTH); + taskMap.put(task, taskInfo); + + taskInfo.setCount(TaskMetric.DEPTH, null, getDepth(task)); + } + + taskInfo.increaseCount(TaskMetric.COUNT, context, 1); + taskInfo.increaseCount(TaskMetric.EVENT_COVERAGE, context, + eventTaskInstancesCovered); + + taskInfo.setCount(TaskMetric.DEPTH, context, depth); + } + + /** + *

+ * internal convenience method to calculate the maximum depth of a task + *

+ */ + private int getDepth(ITask task) { + if (task instanceof IMarkingTemporalRelationship) { + return getDepth(((IMarkingTemporalRelationship) task) + .getMarkedTask()) + 1; + } else if (task instanceof IStructuringTemporalRelationship) { + int maxDepth = 0; + + for (final ITask child : ((IStructuringTemporalRelationship) task) + .getChildren()) { + maxDepth = Math.max(maxDepth, getDepth(child)); + } + + return maxDepth + 1; + } else { + // event tasks + return 1; + } + } + + /** + *

+ * called on initialization to fill the index with infos about the given + * task instance as well as to calculate the appropriate metrics + *

+ */ + private int[] handleTaskInstance(ITaskInstance taskInstance, + ITask context) { + int eventTaskInstancesCovered = 0; + int depth = 0; + + if (taskInstance instanceof ITaskInstanceList) { + for (final ITaskInstance child : (ITaskInstanceList) taskInstance) { + final int[] measures = handleTaskInstance(child, + taskInstance.getTask()); + eventTaskInstancesCovered += measures[0]; + depth = Math.max(depth, measures[1]); + } + + if ((((ITaskInstanceList) taskInstance).size() == 0) + && (taskInstance instanceof IIterationInstance)) { + // ensure also empty task infos for unselected variants + ensureTaskInfo( + ((IIteration) taskInstance.getTask()) + .getMarkedTask(), + context); + } + } else if (taskInstance instanceof ISelectionInstance) { + final ITaskInstance child = ((ISelectionInstance) taskInstance) + .getChild(); + final int[] measures = handleTaskInstance(child, + taskInstance.getTask()); + eventTaskInstancesCovered += measures[0]; + depth = Math.max(depth, measures[1]); + + // ensure also empty task infos for unselected variants + for (final ITask otherChildTask : ((ISelection) taskInstance + .getTask()).getChildren()) { + ensureTaskInfo(otherChildTask, context); + } + } else if (taskInstance instanceof IOptionalInstance) { + final ITaskInstance child = ((IOptionalInstance) taskInstance) + .getChild(); + if (child != null) { + final int[] measures = handleTaskInstance(child, + taskInstance.getTask()); + eventTaskInstancesCovered += measures[0]; + depth = Math.max(depth, measures[1]); + } else { + // ensure also empty task infos for unselected variants + ensureTaskInfo( + ((IOptional) taskInstance.getTask()) + .getMarkedTask(), + context); + } + } else if (taskInstance instanceof IEventTaskInstance) { + eventTaskInstancesCovered = 1; + } + + depth++; + + ensureTaskInfo(taskInstance.getTask(), context, + eventTaskInstancesCovered, depth); + + return new int[] { eventTaskInstancesCovered, depth }; + } + + /** + * + */ + /* + * private void dumpToCSV(PrintStream out) { + * out.println("taskid;depth;count;eventcoverage;eventcoverageratio"); + * + * for (Map.Entry entry : taskMap.entrySet()) { + * out.print(entry.getKey().getId()); out.print(';'); + * out.print(entry.getValue().getMeasureValue(TaskMetric.DEPTH)); + * out.print(';'); + * out.print(entry.getValue().getMeasureValue(TaskMetric.COUNT)); + * out.print(';'); + * out.print(entry.getValue().getMeasureValue(TaskMetric. + * EVENT_COVERAGE)); out.print(';'); + * out.print(entry.getValue().getMeasureValue + * (TaskMetric.EVENT_COVERAGE_RATIO)); out.println(); } } + */ + + } + + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; + + /** + *

+ * all metrics calculated by this type of task model + *

+ */ + private static final TaskMetric[] taskMetrics = new TaskMetric[] { + TaskMetric.COUNT, TaskMetric.DEPTH, TaskMetric.EVENT_COVERAGE, + TaskMetric.EVENT_COVERAGE_RATIO, TaskMetric.EVENT_COVERAGE_QUANTILE }; + + /** + *

+ * the user sessions belonging to the model + *

+ */ + private final List userSessions; + + /** + *

+ * index for effectively accessing the model and calculating statistics + * about it + *

+ */ + private transient TaskModelIndex index = null; + + /** + *

+ * initializes the task model with the user sessions out of which the tasks + * are extracted + *

+ * + * @param userSessions + * as described + */ + TaskModel(List userSessions) { + if ((userSessions == null) || (userSessions.size() == 0)) { + throw new IllegalArgumentException("user sessions must not be null"); + } + + this.userSessions = userSessions; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#clone() + */ + @Override + public TaskModel clone() { + return new TaskModel(userSessions); + } + + /** + *

+ * internal convenience method that initializes the internal index and + * calculates all measures for metrics available for the tasks + *

+ */ + private synchronized void ensureInitialized() { + if (index == null) { + index = new TaskModelIndex(); + + for (final IUserSession session : this.userSessions) { + for (final ITaskInstance taskInstance : session) { + index.handleTaskInstance(taskInstance, null); + } + } + + // count all events covered + int allEventsCovered = 0; + final Collection tasks = getTasks(); + for (final ITask task : tasks) { + if (task instanceof IEventTask) { + allEventsCovered += task.getInstances().size(); + } + } + + final int[] eventCoverageRatios = new int[tasks.size()]; + int i = 0; + + // add some further measures + for (final ITask task : tasks) { + final TaskInfo info = index.taskMap.get(task); + info.addMeasure(TaskMetric.EVENT_COVERAGE_RATIO); + + final int coveredEvents = info + .getMeasureValue(TaskMetric.EVENT_COVERAGE); + int coverageRatio = 0; + + if (allEventsCovered > 0) { + coverageRatio = (coveredEvents * 1000) / allEventsCovered; + } + + eventCoverageRatios[i++] = coverageRatio; + info.setCount(TaskMetric.EVENT_COVERAGE_RATIO, null, + coverageRatio); + } + + Arrays.sort(eventCoverageRatios); + + // add some further measures + for (final ITask task : tasks) { + final TaskInfo info = index.taskMap.get(task); + info.addMeasure(TaskMetric.EVENT_COVERAGE_QUANTILE); + int quantile = Arrays.binarySearch(eventCoverageRatios, + info.getMeasureValue(TaskMetric.EVENT_COVERAGE_RATIO)); + + quantile = (1000 * quantile) / eventCoverageRatios.length; + + info.setCount(TaskMetric.EVENT_COVERAGE_QUANTILE, null, + quantile); + } + + // index.dumpToCSV(System.out); + /* + * try { OutputStream stream = new FileOutputStream(new + * File("tasks.csv")); index.dumpToCSV(new PrintStream(stream)); + * stream.close(); } catch (FileNotFoundException e) { + * e.printStackTrace(); } + */ + } + + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel#getAllMetrics() + */ + @Override + public TaskMetric[] getAllMetrics() { + return taskMetrics; + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel#getTaskInfo(ITask) + */ + @Override + public ITaskInfo getTaskInfo(ITask task) { + ensureInitialized(); + return index.taskMap.get(task); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel#getTasks() + */ + @Override + public Collection getTasks() { + ensureInitialized(); + return Collections.unmodifiableCollection(index.taskMap.keySet()); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskModel#getUserSessions() + */ + @Override + public List getUserSessions() { + ensureInitialized(); + return Collections.unmodifiableList(userSessions); + } } Index: branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/UserSession.java =================================================================== --- branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/UserSession.java (revision 1732) +++ branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/UserSession.java (revision 1733) @@ -33,134 +33,158 @@ */ class UserSession implements IUserSession { - - /** - *

- * default serial version UID - *

- */ - private static final long serialVersionUID = 1L; - - /** - *

- * the task instances belonging to the user session - *

- */ - private List executedTasks = new ArrayList(); - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#get(int) - */ - @Override - public ITaskInstance get(int index) { - return executedTasks.get(index); - } + /** + *

+ * default serial version UID + *

+ */ + private static final long serialVersionUID = 1L; - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#size() - */ - @Override - public int size() { - return executedTasks.size(); - } + /** + *

+ * the task instances belonging to the user session + *

+ */ + private List executedTasks = new ArrayList(); - /* (non-Javadoc) - * @see java.lang.Iterable#iterator() - */ - @Override - public Iterator iterator() { - return executedTasks.iterator(); - } + /** + *

+ * used internally to add a task instance to the user session at a specific + * position + *

+ * + * @param index + * the index the task instance shall be added to + * @param taskInstance + * the task instance to be added + */ + void addExecutedTask(int index, ITaskInstance taskInstance) { + executedTasks.add(index, taskInstance); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IUserSession#getExecutedTasks() - */ - @Override - public List getExecutedTasks() { - return Collections.unmodifiableList(executedTasks); - } + /** + *

+ * used internally to add a task instance to the user session + *

+ * + * @param taskInstance + * the task instance to be added + */ + void addExecutedTask(ITaskInstance taskInstance) { + executedTasks.add(taskInstance); + } - /* (non-Javadoc) - * @see de.ugoe.cs.autoquest.tasktrees.treeifc.IUserSession#equals(IUserSession) - */ - @Override - public boolean equals(IUserSession userSession) { - // task instances are only equal if they are identical or if they have the same id - // (may happen, if they are cloned) - return (this == userSession) || (this.hashCode() == userSession.hashCode()); - } + /* + * (non-Javadoc) + * + * @see java.lang.Object#clone() + */ + @Override + public synchronized IUserSession clone() { + UserSession clone = null; + try { + clone = (UserSession) super.clone(); - /* (non-Javadoc) - * @see java.lang.Object#hashCode() - */ - @Override - public synchronized int hashCode() { - return super.hashCode(); - } + clone.executedTasks = new LinkedList(); - /* (non-Javadoc) - * @see java.lang.Object#toString() - */ - @Override - public synchronized String toString() { - return "session (" + executedTasks.size() + " task instances)"; - } + for (final ITaskInstance child : executedTasks) { + clone.executedTasks.add(child.clone()); + } - /* (non-Javadoc) - * @see java.lang.Object#clone() - */ - @Override - public synchronized IUserSession clone() { - UserSession clone = null; - try { - clone = (UserSession) super.clone(); + } catch (final CloneNotSupportedException e) { + // this should never happen. Therefore simply dump the exception + e.printStackTrace(); + } - clone.executedTasks = new LinkedList(); - - for (ITaskInstance child : executedTasks) { - clone.executedTasks.add(child.clone()); - } + return clone; + } - } - catch (CloneNotSupportedException e) { - // this should never happen. Therefore simply dump the exception - e.printStackTrace(); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.IUserSession#equals(IUserSession) + */ + @Override + public boolean equals(IUserSession userSession) { + // task instances are only equal if they are identical or if they have + // the same id + // (may happen, if they are cloned) + return (this == userSession) + || (this.hashCode() == userSession.hashCode()); + } - return clone; - } + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#get(int) + */ + @Override + public ITaskInstance get(int index) { + return executedTasks.get(index); + } - /** - *

- * used internally to add a task instance to the user session - *

- * - * @param taskInstance the task instance to be added - */ - void addExecutedTask(ITaskInstance taskInstance) { - executedTasks.add(taskInstance); - } + /* + * (non-Javadoc) + * + * @see + * de.ugoe.cs.autoquest.tasktrees.treeifc.IUserSession#getExecutedTasks() + */ + @Override + public List getExecutedTasks() { + return Collections.unmodifiableList(executedTasks); + } - /** - *

- * used internally to add a task instance to the user session at a specific position - *

- * - * @param index the index the task instance shall be added to - * @param taskInstance the task instance to be added - */ - void addExecutedTask(int index, ITaskInstance taskInstance) { - executedTasks.add(index, taskInstance); - } + /* + * (non-Javadoc) + * + * @see java.lang.Object#hashCode() + */ + @Override + public synchronized int hashCode() { + return super.hashCode(); + } - /** - *

- * used internally to remove a task instance from the user session - *

- * - * @param index the index of the task instance to be removed - */ - void removeExecutedTask(int index) { - executedTasks.remove(index); - } + /* + * (non-Javadoc) + * + * @see java.lang.Iterable#iterator() + */ + @Override + public Iterator iterator() { + return executedTasks.iterator(); + } + + /** + *

+ * used internally to remove a task instance from the user session + *

+ * + * @param index + * the index of the task instance to be removed + */ + void removeExecutedTask(int index) { + executedTasks.remove(index); + } + + /* + * (non-Javadoc) + * + * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskInstanceList#size() + */ + @Override + public int size() { + return executedTasks.size(); + } + + /* + * (non-Javadoc) + * + * @see java.lang.Object#toString() + */ + @Override + public synchronized String toString() { + return "session (" + executedTasks.size() + " task instances)"; + } }