Package com.thingworx.types.data.sorters

Class GenericSorter

java.lang.Object

com.thingworx.types.data.sorters.GenericSorter

All Implemented Interfaces:

ISort, java.util.Comparator<ValueCollection>

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class GenericSorter
extends java.lang.Object
implements ISort

General purpose sorter for a single data field.

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	ASCENDING
static boolean	DESCENDING

Constructor Summary

Constructors

Constructor	Description
GenericSorter()
GenericSorter(java.lang.String fieldName, boolean ascending)
GenericSorter(java.lang.String fieldName, boolean ascending, boolean caseSensitive)

Method Summary

Modifier and Type	Method	Description
int	compare(ValueCollection row1, ValueCollection row2)
java.lang.String	getFieldName()
boolean	isAscending()
boolean	isCaseSensitive()
void	resolveFields(DataShapeDefinition metadata)
void	setAscending(boolean value)
void	setFieldName(java.lang.String value)
org.json.JSONObject	toJSON()	Produces JSON representation of this sorter.
org.json.JSONArray	toJSONArray()	Produces JSONArray containing result of 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

Field Detail

ASCENDING

public static final boolean ASCENDING

See Also:

Constant Field Values

DESCENDING

public static final boolean DESCENDING

See Also:

Constant Field Values

Constructor Detail

GenericSorter

@ThingworxExtensionApiMethod(since={6,6})
public GenericSorter(java.lang.String fieldName,
                     boolean ascending)

GenericSorter

@ThingworxExtensionApiMethod(since={6,6})
public GenericSorter(java.lang.String fieldName,
                     boolean ascending,
                     boolean caseSensitive)

GenericSorter

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

Method Detail

getFieldName

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

Specified by:

getFieldName in interface ISort

setFieldName

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

Specified by:

setFieldName 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

resolveFields

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

Specified by:

resolveFields in interface ISort

compare

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

Specified by:

compare in interface java.util.Comparator<ValueCollection>

isCaseSensitive

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

Specified by:

isCaseSensitive in interface ISort

toJSON

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

Produces JSON representation of this sorter. Fields are as follows:

• CommonPropertyNames.PROP_FIELDNAME: getFieldName() result
• CommonPropertyNames.PROP_ISASCENDING: isAscending() result, when false
• CommonPropertyNames.PROP_ISCASESENSITIVE: isCaseSensitive() result, when false

Specified by:

toJSON in interface ISort

Returns:

JSON representation of this sorter

Throws:

org.json.JSONException - Upon internal errors

toJSONArray

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

Produces JSONArray containing result of toJSON().

Specified by:

toJSONArray in interface ISort

Returns:

JSONArray representation of this sorter

Throws:

org.json.JSONException - Upon internal errors