marf.util.comparators
Class FrequencyComparator

java.lang.Object
  |
  +--marf.util.SortComparator
        |
        +--marf.util.comparators.FrequencyComparator

All Implemented Interfaces:

java.util.Comparator, java.io.Serializable

public class FrequencyComparator

extends SortComparator

Compare WordStats objects by their frequency when sorting.

$Id: FrequencyComparator.java,v 1.14 2005/08/14 01:15:57 mokhov Exp $

Since:

0.3.0

Version:

$Revision: 1.14 $

Author:

Serguei Mokhov

See Also:

WordStats, Serialized Form

Field Summary

Fields inherited from class marf.util.SortComparator

ASCENDING, DESCENDING, iSortMode

Constructor Summary

FrequencyComparator(int piSortMode)
Constructs a frequency comparator with the specified sort mode.

Method Summary

int	compare(java.lang.Object poWordStats1, java.lang.Object poWordStats2) Implementation of the Comparator interface for the WordStats objects.
static java.lang.String	getMARFSourceCodeRevision() Returns source code revision information.

Methods inherited from class marf.util.SortComparator

getSortMode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals

Constructor Detail

FrequencyComparator

public FrequencyComparator(int piSortMode)

Constructs a frequency comparator with the specified sort mode.

Parameters:

piSortMode - ASCENDING or DESCENDING

Method Detail

compare

public int compare(java.lang.Object poWordStats1,
                   java.lang.Object poWordStats2)

Implementation of the Comparator interface for the WordStats objects. To decide on inequality of the WordStats objects we compare their frequencies only.

Parameters:

poWordStats1 - first WordStats object to compare

poWordStats2 - second WordStats object to compare

Returns:

0 of the frequencies are equal. Depending on the sort mode; a negative value may mean poWordStats1 < poWordStats2 if ASCENDING; or otherwise if DESCENDING

See Also:

Comparator.compare(java.lang.Object, java.lang.Object), WordStats

getMARFSourceCodeRevision

public static java.lang.String getMARFSourceCodeRevision()

Returns source code revision information.

Returns:

revision string