com.thingworx.types.data.sorters

Interface ISort

All Superinterfaces:

java.util.Comparator<ValueCollection>

All Known Implementing Classes:

GenericSorter, SortCollection

@ThingworxExtensionApiClass(since={6,6})
public interface ISort
extends java.util.Comparator<ValueCollection>

General sorter interface for use with Query.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldName()
boolean	isAscending()
boolean	isCaseSensitive()
void	resolveFields(DataShapeDefinition fields)
void	setAscending(boolean value)
void	setFieldName(java.lang.String value)
java.lang.Object	toJSON() Produces JSON representation of this sorter as either JSONObject or JSONArray as most appropriate.
org.json.JSONArray	toJSONArray() Produces JSONArray representation of this sorter.

Methods inherited from interface java.util.Comparator

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

Method Detail

getFieldName

@ThingworxExtensionApiMethod(since={6,6})
java.lang.String getFieldName()

setFieldName

@ThingworxExtensionApiMethod(since={6,6})
void setFieldName(java.lang.String value)

isAscending

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

isCaseSensitive

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

setAscending

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

resolveFields

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

toJSON

@ThingworxExtensionApiMethod(since={6,6})
java.lang.Object toJSON()
                                                           throws org.json.JSONException

Produces JSON representation of this sorter as either JSONObject or JSONArray as most appropriate.

Returns:

JSON representation of this sorter

Throws:

org.json.JSONException - Upon internal errors

toJSONArray

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

Produces JSONArray representation of this sorter.

Returns:

JSONArray representation of this sorter

Throws:

org.json.JSONException - Upon internal errors