viper.comparison.distances
Class Distances.DefaultDifference

java.lang.Object
  viper.comparison.distances.Distances.DefaultDifference

All Implemented Interfaces:

Measurable.Difference

Enclosing class:

Distances

public static class Distances.DefaultDifference

extends java.lang.Object

implements Measurable.Difference

A simple differnece object, which keeps track of some information about a computed difference. This includes the compared value, any blackout or don't care values, and the file information.

Constructor Summary

Distances.DefaultDifference(java.lang.Object alpha, java.lang.Object beta, java.lang.Object blackout, java.lang.Object ignore, CanonicalFileDescriptor cfd)
Constructs a new difference object.

Method Summary

java.lang.Object	getAlpha() Gets the target value.
java.lang.Object	getBeta() Gets the candidate object.
java.lang.Object	getBlackout() Gets the blackout value.
CanonicalFileDescriptor	getFileInformation() Gets information about the source media file where the object originated.
java.lang.Object	getIgnore() Gets the value to ignore/region to ignore.

Methods inherited from class java.lang.Object

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

Constructor Detail

Distances.DefaultDifference

public Distances.DefaultDifference(java.lang.Object alpha,
                                   java.lang.Object beta,
                                   java.lang.Object blackout,
                                   java.lang.Object ignore,
                                   CanonicalFileDescriptor cfd)

Constructs a new difference object.

Parameters:

alpha - the target value

beta - the candidate value

blackout - the bad region

ignore - the ignored region

cfd - information about the containing file

Method Detail

getAlpha

public java.lang.Object getAlpha()

Description copied from interface: Measurable.Difference

Gets the target value.

Specified by:

getAlpha in interface Measurable.Difference

Returns:

the target value

getBeta

public java.lang.Object getBeta()

Description copied from interface: Measurable.Difference

Gets the candidate object.

Specified by:

getBeta in interface Measurable.Difference

Returns:

the candidate measurable

getBlackout

public java.lang.Object getBlackout()

Description copied from interface: Measurable.Difference

Gets the blackout value.

Specified by:

getBlackout in interface Measurable.Difference

Returns:

the blackout value

getIgnore

public java.lang.Object getIgnore()

Description copied from interface: Measurable.Difference

Gets the value to ignore/region to ignore.

Specified by:

getIgnore in interface Measurable.Difference

Returns:

the don't care value

getFileInformation

public CanonicalFileDescriptor getFileInformation()

Description copied from interface: Measurable.Difference

Gets information about the source media file where the object originated.

Specified by:

getFileInformation in interface Measurable.Difference

Returns:

the source media description