com.inductiveautomation.rm.base

Class RMTopNSort

java.lang.Object

com.inductiveautomation.rm.base.RMSort

com.inductiveautomation.rm.base.RMTopNSort

All Implemented Interfaces:

Archivable, RMJSONArchiver.GetKeys, java.lang.Cloneable, java.util.Comparator

public class RMTopNSort
extends RMSort

This is a sort subclass to support sorting objects by their relative position in an array of values.

Field Summary

Fields inherited from class com.inductiveautomation.rm.base.RMSort

COMPARATOR, ORDER_ASCEND, ORDER_DESCEND, ORDER_INDETERMINATE, ORDER_SAME

Constructor Summary

Constructors

Constructor and Description
RMTopNSort() Creates a new value sort.
RMTopNSort(java.lang.String aKey, int anOrder, int aCount, boolean includeOthers) Creates a new value sort.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.lang.Object	fromXML(RXArchiver anArchiver, RXElement anElement) XML unarchival.
int	getCount() Returns the count.
boolean	getIncludeOthers() Returns whether to include others.
boolean	getPad() Returns whether to pad to top N value.
void	setCount(int aCount) Sets the count.
void	setIncludeOthers(boolean includeOthers) Sets whether to include others.
void	setPad(boolean aValue) Sets whether to pad to top N value.
java.lang.String	toString() Returns a string representation of top n sort.
RXElement	toXML(RXArchiver anArchiver) XML archival.

Methods inherited from class com.inductiveautomation.rm.base.RMSort

clone, compare, Compare, getJSONKeys, getKey, getOrder, getOrderDefault, getOrderString, setKey, setOrder, setOrderString, sort, sort, sort, sort, sort, sortedList, sortedList, sortedList, toggleOrder

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

RMTopNSort

public RMTopNSort()

Creates a new value sort.

RMTopNSort

public RMTopNSort(java.lang.String aKey,
                  int anOrder,
                  int aCount,
                  boolean includeOthers)

Creates a new value sort.

Method Detail

getCount

public int getCount()

Returns the count.

setCount

public void setCount(int aCount)

Sets the count.

getIncludeOthers

public boolean getIncludeOthers()

Returns whether to include others.

setIncludeOthers

public void setIncludeOthers(boolean includeOthers)

Sets whether to include others.

getPad

public boolean getPad()

Returns whether to pad to top N value.

setPad

public void setPad(boolean aValue)

Sets whether to pad to top N value.

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Specified by:

equals in interface java.util.Comparator

Overrides:

equals in class RMSort

toXML

public RXElement toXML(RXArchiver anArchiver)

XML archival.

Specified by:

toXML in interface Archivable

Overrides:

toXML in class RMSort

fromXML

public java.lang.Object fromXML(RXArchiver anArchiver,
                                RXElement anElement)

XML unarchival.

Specified by:

fromXML in interface Archivable

Overrides:

fromXML in class RMSort

toString

public java.lang.String toString()

Returns a string representation of top n sort.

Overrides:

toString in class RMSort