com.aspose.cells

Class DataSorter

java.lang.Object

com.aspose.cells.DataSorter

public class DataSorter
extends java.lang.Object

Summary description for DataSorter.

Example

 
         //Instantiate a new Workbook object.
         Workbook workbook = new Workbook("Book1.xls");
         //Get the workbook datasorter object.
         DataSorter sorter = workbook.getDataSorter();
         //Set the first order for datasorter object.
         sorter.setOrder1(com.aspose.cells.SortOrder.DESCENDING);
         //Define the first key.
         sorter.setKey1(0);
         //Set the second order for datasorter object.
         sorter.setOrder2(com.aspose.cells.SortOrder.ASCENDING);
         //Define the second key.
         sorter.setKey2(1);
         //Create a cells area (range).
         CellArea ca = new CellArea();
         //Specify the start row index.
         ca.StartRow = 0;
         //Specify the start column index.
         ca.StartColumn = 0;
         //Specify the last row index.
         ca.EndRow = 13;
         //Specify the last column index.
         ca.EndColumn = 1;
         //Sort data in the specified data range (A1:B14)
         sorter.sort(workbook.getWorksheets().get(0).getCells(), ca);
         //Save the excel file.
         workbook.save("outBook.xls");
 

Method Summary

Methods

Modifier and Type	Method and Description
void	addColorKey(int key, int type, int order, Color color) Adds color sort key.
void	addKey(int key, int order) Adds sorted column index and sort order.
void	addKey(int key, int type, int order, java.lang.Object customList) Adds sorted column index and sort order with custom sort list.
void	addKey(int key, int order, java.lang.String customList) Adds sorted column index and sort order with custom sort list.
void	addKey(int key, int order, java.lang.String[] customList) Adds sorted column index and sort order with custom sort list.
void	clear() Clear all settings.
boolean	getCaseSensitive() Gets whether case sensitive when comparing string.
int	getKey1() Represents first sorted column index(absolute position, column A is 0, B is 1, ...).
int	getKey2() Represents second sorted column index(absolute position, column A is 0, B is 1, ...).
int	getKey3() Represents third sorted column index(absolute position, column A is 0, B is 1, ...).
DataSorterKeyCollection	getKeys() Gets the key list of data sorter.
int	getOrder1() Represents sort order of the first key.
int	getOrder2() Represents sort order of the second key.
int	getOrder3() Represents sort order of the third key.
boolean	getSortAsNumber() Indicates whether sorting anything that looks like a number.
boolean	getSortLeftToRight() True means that sorting orientation is from left to right.
boolean	hasHeaders() Represents whether the range has headers.
void	setCaseSensitive(boolean value) Sets whether case sensitive when comparing string.
void	setHasHeaders(boolean value) Represents whether the range has headers.
void	setKey1(int value) Represents first sorted column index(absolute position, column A is 0, B is 1, ...).
void	setKey2(int value) Represents second sorted column index(absolute position, column A is 0, B is 1, ...).
void	setKey3(int value) Represents third sorted column index(absolute position, column A is 0, B is 1, ...).
void	setOrder1(int value) Represents sort order of the first key.
void	setOrder2(int value) Represents sort order of the second key.
void	setOrder3(int value) Represents sort order of the third key.
void	setSortAsNumber(boolean value) Indicates whether sorting anything that looks like a number.
void	setSortLeftToRight(boolean value) True means that sorting orientation is from left to right.
int[]	sort() Sort the data in the range.
int[]	sort(Cells cells, CellArea area) Sort the data of the area.
int[]	sort(Cells cells, int startRow, int startColumn, int endRow, int endColumn) Sorts the data of the area.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getKeys

public DataSorterKeyCollection getKeys()

Gets the key list of data sorter.

clear

public void clear()

Clear all settings.

hasHeaders

public boolean hasHeaders()

Represents whether the range has headers.

setHasHeaders

public void setHasHeaders(boolean value)

Represents whether the range has headers.

addKey

public void addKey(int key,
          int order)

Adds sorted column index and sort order.

Parameters:

key - The sorted column index(absolute position, column A is 0, B is 1, ...)

order - SortOrder. The sort order

addKey

public void addKey(int key,
          int order,
          java.lang.String customList)

Adds sorted column index and sort order with custom sort list.

Parameters:

key - The sorted column index(absolute position, column A is 0, B is 1, ...)

order - SortOrder. The sort order.

customList - The custom sort list.

addColorKey

public void addColorKey(int key,
               int type,
               int order,
               Color color)

Adds color sort key.

Parameters:

key - The sorted column index(absolute position, column A is 0, B is 1, ...)

type - SortOnType. The sorted color value type.

order - SortOrder. The sort order.

color - The custom sort color.

addKey

public void addKey(int key,
          int type,
          int order,
          java.lang.Object customList)

Adds sorted column index and sort order with custom sort list.

Remarks

If type is SortOnType.CellColor or SortOnType.FontColor, the customList is Color.

Parameters:

key - The sorted column index(absolute position, column A is 0, B is 1, ...)

type - SortOnType. The sorted value type.

order - SortOrder. The sort order.

customList - The custom sort list.

addKey

public void addKey(int key,
          int order,
          java.lang.String[] customList)

Adds sorted column index and sort order with custom sort list.

Parameters:

key - The sorted column index(absolute position, column A is 0, B is 1, ...)

order - SortOrder. The sort order.

customList - The custom sort list.

getKey1

public int getKey1()

Represents first sorted column index(absolute position, column A is 0, B is 1, ...).

setKey1

public void setKey1(int value)

Represents first sorted column index(absolute position, column A is 0, B is 1, ...).

getOrder1

public int getOrder1()

Represents sort order of the first key.

See SortOrder.

setOrder1

public void setOrder1(int value)

Represents sort order of the first key.

See SortOrder.

getKey2

public int getKey2()

Represents second sorted column index(absolute position, column A is 0, B is 1, ...).

setKey2

public void setKey2(int value)

Represents second sorted column index(absolute position, column A is 0, B is 1, ...).

getOrder2

public int getOrder2()

Represents sort order of the second key.

See SortOrder.

setOrder2

public void setOrder2(int value)

Represents sort order of the second key.

See SortOrder.

getKey3

public int getKey3()

Represents third sorted column index(absolute position, column A is 0, B is 1, ...).

setKey3

public void setKey3(int value)

Represents third sorted column index(absolute position, column A is 0, B is 1, ...).

getOrder3

public int getOrder3()

Represents sort order of the third key.

See SortOrder.

setOrder3

public void setOrder3(int value)

Represents sort order of the third key.

See SortOrder.

getSortLeftToRight

public boolean getSortLeftToRight()

True means that sorting orientation is from left to right. False means that sorting orientation is from top to bottom. The default value is false.

setSortLeftToRight

public void setSortLeftToRight(boolean value)

True means that sorting orientation is from left to right. False means that sorting orientation is from top to bottom. The default value is false.

getCaseSensitive

public boolean getCaseSensitive()

Gets whether case sensitive when comparing string.

setCaseSensitive

public void setCaseSensitive(boolean value)

Sets whether case sensitive when comparing string.

getSortAsNumber

public boolean getSortAsNumber()

Indicates whether sorting anything that looks like a number.

setSortAsNumber

public void setSortAsNumber(boolean value)

Indicates whether sorting anything that looks like a number.

sort

public int[] sort(Cells cells,
         int startRow,
         int startColumn,
         int endRow,
         int endColumn)

Sorts the data of the area.

Parameters:

cells - The cells contains the data area.

startRow - The start row of the area.

startColumn - The start column of the area.

endRow - The end row of the area.

endColumn - The end column of the area.

Returns:

the original indices(absolute position, for example, column A is 0, B is 1, ...) of the sorted rows/columns. If no rows/columns needs to be moved by this sorting operation, null will be returned.

sort

public int[] sort(Cells cells,
         CellArea area)

Sort the data of the area.

Parameters:

cells - The cells contains the data area.

area - The area needed to sort

Returns:

the original indices(absolute position, for example, column A is 0, B is 1, ...) of the sorted rows/columns. If no rows/columns needs to be moved by this sorting operation, null will be returned.

sort

public int[] sort()

Sort the data in the range.

Returns:

the original indices(absolute position, for example, column A is 0, B is 1, ...) of the sorted rows/columns. If no rows/columns needs to be moved by this sorting operation, null will be returned.