org.apache.ctakes.utils.xcas_comparison

Class XcasDiff

java.lang.Object

org.apache.ctakes.utils.xcas_comparison.XcasDiff

public class XcasDiff
extends Object

An XcasDiff object represents the comparison results of two XCAS files. It also provides methods to output these results.

Author:

Mayo Clinic

Constructor Summary

Constructors

Constructor and Description
XcasDiff() Default constructor.
XcasDiff(XcasFile xf1, XcasFile xf2) Construct an XCASDiff object from two XcasFile objects.

Method Summary

Methods

Modifier and Type	Method and Description
void	printCommon() Prints common elements along with their attributes in the two XCAS files to stdout.
void	printDiff() Prints elements that are unique to each XCAS file to stdout.
static void	printDiff(XcasFile f1, XcasFile f2) Prints elements that are unique to each XCAS file to stdout.
void	printHTML(Writer w) Writes an HTML summary of the comparison of the two XCAS files.
static void	printHTML(XcasFile f1, XcasFile f2, Writer w) Writes an HTML summary of the comparison of the two specified XCAS files.
void	printUniq(int i) Prints elements that are unique to XCAS file i.
void	recalculate() Calculates the differences or recalculates after the two files are updated.

Methods inherited from class java.lang.Object

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

Constructor Detail

XcasDiff

public XcasDiff()

Default constructor.

XcasDiff

public XcasDiff(XcasFile xf1,
        XcasFile xf2)

Construct an XCASDiff object from two XcasFile objects.

Parameters:

xf1 - An XcasFile object.

xf2 - Another XcasFile object.

Method Detail

recalculate

public final void recalculate()

Calculates the differences or recalculates after the two files are updated. Works on an copy of the original annotations. Original objects are not touched. Must be called if the original XcasFile is modified elsewhere.

printCommon

public void printCommon()

Prints common elements along with their attributes in the two XCAS files to stdout.

printDiff

public void printDiff()

Prints elements that are unique to each XCAS file to stdout.

printUniq

public void printUniq(int i)

Prints elements that are unique to XCAS file i.

Parameters:

i - XCAS file number, specified when constructing this object, can only be 1 or 2.

printHTML

public void printHTML(Writer w)

Writes an HTML summary of the comparison of the two XCAS files.

Parameters:

w - An Writer object to write to.

printDiff

public static void printDiff(XcasFile f1,
             XcasFile f2)

Prints elements that are unique to each XCAS file to stdout. First constructs an anonymous XcasDiff object, and calls its printDiff(). Avoid using this method if you plan to use XcasDiff object later.

Parameters:

f1 - An XcasFile object.

f2 - Another XcasFile object.

See Also:

printDiff()

printHTML

public static void printHTML(XcasFile f1,
             XcasFile f2,
             Writer w)

Writes an HTML summary of the comparison of the two specified XCAS files. First constructs an anonymous XcasDiff object, and calls its printHTML(Writer). Avoid using this method if you plan to use XcasDiff object later.

Parameters:

f1 - An XcasFile object.

f2 - Another XcasFile object.

w - An Writer object to write to.