Package com.thingworx.types.data.sorters

Class SortCollection

java.lang.Object

com.thingworx.types.data.sorters.SortCollection

All Implemented Interfaces:

ISort, Comparator<ValueCollection>

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class SortCollection
extends Object
implements ISort

Sorter based on the composition of a collection of child sorters.

Constructor Summary

Constructors

Constructor	Description
SortCollection()

Method Summary

Modifier and Type	Method	Description
void	addSort(ISort sort)
void	clearSorts()
int	compare(ValueCollection row1, ValueCollection row2)
String	getFieldName()
ArrayList<ISort>	getSorters()
boolean	isAscending()
boolean	isCaseSensitive()
void	resolveFields(DataShapeDefinition fields)
void	setAscending(boolean value)
void	setFieldName(String value)
org.json.JSONArray	toJSON()	Produces JSONArray of child sorters' JSON representations.
org.json.JSONArray	toJSONArray()	Produces JSONArray representation of this sorter as per toJSON().

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, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Details

SortCollection

@ThingworxExtensionApiMethod(since={6,6})
public SortCollection()

Method Details

addSort

@ThingworxExtensionApiMethod(since={6,6})
public void addSort(ISort sort)

clearSorts

@ThingworxExtensionApiMethod(since={6,6})
public void clearSorts()

getSorters

@ThingworxExtensionApiMethod(since={6,6})
public ArrayList<ISort> getSorters()

resolveFields

@ThingworxExtensionApiMethod(since={6,6})
public void resolveFields(DataShapeDefinition fields)

Specified by:

resolveFields in interface ISort

compare

@ThingworxExtensionApiMethod(since={6,6})
public int compare(ValueCollection row1,
 ValueCollection row2)

Specified by:

compare in interface Comparator<ValueCollection>

getFieldName

@ThingworxExtensionApiMethod(since={6,6})
public String getFieldName()

Specified by:

getFieldName in interface ISort

isAscending

@ThingworxExtensionApiMethod(since={6,6})
public boolean isAscending()

Specified by:

isAscending in interface ISort

setAscending

@ThingworxExtensionApiMethod(since={6,6})
public void setAscending(boolean value)

Specified by:

setAscending in interface ISort

setFieldName

@ThingworxExtensionApiMethod(since={6,6})
public void setFieldName(String value)

Specified by:

setFieldName in interface ISort

isCaseSensitive

@ThingworxExtensionApiMethod(since={6,6})
public boolean isCaseSensitive()

Specified by:

isCaseSensitive in interface ISort

toJSON

@ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONArray toJSON()
                          throws org.json.JSONException

Produces JSONArray of child sorters' JSON representations.

Specified by:

toJSON in interface ISort

Returns:

JSON representation of this sorter

Throws:

org.json.JSONException - Upon internal errors

See Also:

• getSorters()

toJSONArray

@ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONArray toJSONArray()
                               throws org.json.JSONException

Produces JSONArray representation of this sorter as per toJSON().

Specified by:

toJSONArray in interface ISort

Returns:

JSONArray representation of this sorter

Throws:

org.json.JSONException - Upon internal errors