com.aspose.cells
Class DataSorter

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

public class DataSorter 
extends java.lang.Object

//Instantiate a new Workbook object.
Workbook workbook = new Workbook("C:\\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("C:\\outBook.xls");

public DataSorterKeyCollection getKeys()

Gets the key list of data sorter.

public boolean hasHeaders() / public void setHasHeaders(boolean value)

Represents whether the range has headers.

public int getKey1() / public void setKey1(int value)

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

public int getOrder1() / public void setOrder1(int value)

Represents sort order of the first key. The value of the property is SortOrder integer constant.

public int getKey2() / public void setKey2(int value)

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

public int getOrder2() / public void setOrder2(int value)

Represents sort order of the second key. The value of the property is SortOrder integer constant.

public int getKey3() / public void setKey3(int value)

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

public int getOrder3() / public void setOrder3(int value)

Represents sort order of the third key. The value of the property is SortOrder integer constant.

public boolean getSortLeftToRight() / 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.

public boolean getCaseSensitive() / public void setCaseSensitive(boolean value)

Gets and sets whether case sensitive when comparing string.

public boolean getSortAsNumber() / public void setSortAsNumber(boolean value)

Indicates whether sorting anything that looks like a number.

public void clear()

Clear all settings.

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 - A SortOrder value. The sort order

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 - A SortOrder value. The sort order.

customList - The custom sort list.

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

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

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 - A SortOnType value. The sorted value type.

order - A SortOrder value. The sort order.

customList - The custom sort list.

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 - A SortOrder value. The sort order.

customList - The custom sort list.

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.

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.

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.