com.netflix.hollow.tools.diff.count

Class HollowFieldDiff

java.lang.Object

com.netflix.hollow.tools.diff.count.HollowFieldDiff

All Implemented Interfaces:

java.lang.Comparable<HollowFieldDiff>

public class HollowFieldDiff
extends java.lang.Object
implements java.lang.Comparable<HollowFieldDiff>

Obtained via a HollowTypeDiff, this is a report of the differences in a specific field between two data states.

Constructor Summary

Constructors

Constructor and Description
HollowFieldDiff(HollowDiffNodeIdentifier fieldIdentifier)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDiff(int fromOrdinal, int toOrdinal, int score) Should be called exclusively from the HollowDiff -- not intended for external consumption
void	addResults(HollowFieldDiff otherFieldDiff) This should be called exclusively from the HollowDiff.
int	compareTo(HollowFieldDiff o) Comparison is based on the totalDiffScore().
HollowDiffNodeIdentifier	getFieldIdentifier()
int	getFromOrdinal(int diffPairIdx)
int	getNumDiffs()
int	getPairScore(int diffPairIdx)
int	getToOrdinal(int diffPairIdx)
long	getTotalDiffScore()

Methods inherited from class java.lang.Object

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

Constructor Detail

HollowFieldDiff

public HollowFieldDiff(HollowDiffNodeIdentifier fieldIdentifier)

Method Detail

addDiff

public void addDiff(int fromOrdinal,
           int toOrdinal,
           int score)

Should be called exclusively from the HollowDiff -- not intended for external consumption

getFieldIdentifier

public HollowDiffNodeIdentifier getFieldIdentifier()

Returns:

The identifier for the field on which this diff reports.

getTotalDiffScore

public long getTotalDiffScore()

Returns:

the total score, used to judge relative magnitude of the diff.

getNumDiffs

public int getNumDiffs()

Returns:

the number of records which had at least one diff for this field.

getFromOrdinal

public int getFromOrdinal(int diffPairIdx)

Parameters:

diffPairIdx - a number from 0-n, where n is the value returned from numDiffs

Returns:

the from ordinal for the (diffPairIdx)th record pair in which there were differences for this field.

getToOrdinal

public int getToOrdinal(int diffPairIdx)

Parameters:

diffPairIdx - a number from 0-n, where n is the value returned from numDiffs

Returns:

the to ordinal for the (diffPairIdx)th record pair in which there were differences for this field.

getPairScore

public int getPairScore(int diffPairIdx)

Parameters:

diffPairIdx - a number from 0-n, where n is the value returned from numDiffs

Returns:

the score of the diff for this field in the (diffPairIdx)th record pair in which there were differences for this field.

addResults

public void addResults(HollowFieldDiff otherFieldDiff)

This should be called exclusively from the HollowDiff. Not for external consumption.

compareTo

public int compareTo(HollowFieldDiff o)

Comparison is based on the totalDiffScore().

Specified by:

compareTo in interface java.lang.Comparable<HollowFieldDiff>