Package 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 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
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
-
-
-
-
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.
-
toXML
public RXElement toXML(RXArchiver anArchiver)
XML archival.- Specified by:
toXML
in interfaceArchivable
- Overrides:
toXML
in classRMSort
-
fromXML
public java.lang.Object fromXML(RXArchiver anArchiver, RXElement anElement)
XML unarchival.- Specified by:
fromXML
in interfaceArchivable
- Overrides:
fromXML
in classRMSort
-
-