Package adams.data.spectrum

Class SpectrumComparator

java.lang.Object

adams.data.container.DataPointComparator<Spectrum>

adams.data.spectrum.AbstractSpectrumComparator

adams.data.spectrum.SpectrumComparator

All Implemented Interfaces:

adams.core.Destroyable, adams.core.option.OptionHandler, Serializable, Comparator<Spectrum>

public class SpectrumComparator
extends AbstractSpectrumComparator

A comparator for Spectrum objects.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.spectrum.AbstractSpectrumComparator

m_OptionManager

Fields inherited from class adams.data.container.DataPointComparator

m_Ascending

Constructor Summary

Constructors

Constructor	Description
SpectrumComparator()

Method Summary

Modifier and Type	Method	Description
int	compare(Spectrum o1, Spectrum o2)	Compares its two arguments for order.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.data.spectrum.AbstractSpectrumComparator

ascendingTipText, cleanUpOptions, defineOptions, destroy, finishInit, getOptionManager, initialize, newOptionManager, reset, setAscending, toCommandLine, toString

Methods inherited from class adams.data.container.DataPointComparator

isAscending

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

SpectrumComparator

public SpectrumComparator()

Method Detail

globalInfo

public String globalInfo()

Description copied from class: AbstractSpectrumComparator

Returns a string describing the object.

Specified by:

globalInfo in class AbstractSpectrumComparator

Returns:

a description suitable for displaying in the gui

compare

public int compare(Spectrum o1,
                   Spectrum o2)

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Specified by:

compare in interface Comparator<Spectrum>

Specified by:

compare in class adams.data.container.DataPointComparator<Spectrum>

Parameters:

o1 - the first object

o2 - the second object

Returns:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.