Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class DataSorter

java.lang.Object
  extended by com.aspose.cells.DataSorter

public class DataSorter
extends java.lang.Object

Represents data sorter.


Method Summary
 void clear()
          Clear all setting for this data sorter.
 int getKey1()
          Represents first sorted key's column index.
 int getKey2()
          Gets second sorted key's column index.
 int getKey3()
          Gets third sorted key's column index.
 byte getOrder1()
          Represents sort order of the first key.
 byte getOrder2()
          Gets sort order of the second key.
 byte getOrder3()
          Gets sort order of the third key.
 boolean hasHeaders()
          Indicates whether the sorted range has header.
 boolean isCaseSensitive()
          Indicates whether case sensitive when comparing string.
 void setCaseSensitive(boolean caseSensitive)
          Sets whether case sensitive when comparing string.
 void setHasHeders(boolean hasHeaders)
          Sets whether the sorted range has header.
 void setKey1(int key1)
          Sets first sorted key's column index.
 void setKey2(int key2)
          Sets second sorted key's column index.
 void setKey3(int key3)
          Sets third sorted key's column index.
 void setOrder1(byte order1)
          Sets sort order of the first key.
 void setOrder2(byte order2)
          Sets sort order of the second key.
 void setOrder3(byte order3)
          Sets sort order of the third key.
 void sort(Cells cells, CellArea area)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

clear

public void clear()
Clear all setting for this data sorter.


hasHeaders

public boolean hasHeaders()
Indicates whether the sorted range has header.

Returns:
whether the sorted range has header.

setHasHeders

public void setHasHeders(boolean hasHeaders)
Sets whether the sorted range has header.

Parameters:
hasHeaders - whether the sorted range has header.

getKey1

public int getKey1()
Represents first sorted key's column index.

Returns:
first sorted key's column index.

setKey1

public void setKey1(int key1)
Sets first sorted key's column index.

Parameters:
key1 - first sorted key's column index.

getOrder1

public byte getOrder1()
Represents sort order of the first key.

Returns:
sort order of the first key.

setOrder1

public void setOrder1(byte order1)
Sets sort order of the first key.

Parameters:
order1 - sort order of the first key. Supported order: SortOrderType.ASCENDING or SortOrderType.DESCENDING

getKey2

public int getKey2()
Gets second sorted key's column index.

Returns:
second sorted key's column index.

setKey2

public void setKey2(int key2)
Sets second sorted key's column index.

Parameters:
key2 - second sorted key's column index.

getOrder2

public byte getOrder2()
Gets sort order of the second key.

Returns:
sort order of the second key.

setOrder2

public void setOrder2(byte order2)
Sets sort order of the second key.

Parameters:
order2 - sort order of the second key. Supported order: SortOrderType.ASCENDING or SortOrderType.DESCENDING

getKey3

public int getKey3()
Gets third sorted key's column index.

Returns:
third sorted key's column index.

setKey3

public void setKey3(int key3)
Sets third sorted key's column index.

Parameters:
key3 - third sorted key's column index.

getOrder3

public byte getOrder3()
Gets sort order of the third key.

Returns:
sort order of the third key.

setOrder3

public void setOrder3(byte order3)
Sets sort order of the third key.

Parameters:
order3 - sort order of the third key. Supported order: SortOrderType.ASCENDING or SortOrderType.DESCENDING

isCaseSensitive

public boolean isCaseSensitive()
Indicates whether case sensitive when comparing string.

Returns:
whether case sensitive when comparing string.

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)
Sets whether case sensitive when comparing string.

Parameters:
caseSensitive - whether case sensitive when comparing string.

sort

public void sort(Cells cells,
                 CellArea area)