com.sas.dataselectors.sort
Interface OLAPSortSelectorInterface

All Superinterfaces:

com.sas.util.SortDirectionInterface

All Known Implementing Classes:

OLAPSortSelectorAdapter

public interface OLAPSortSelectorInterface
extends com.sas.util.SortDirectionInterface

The OLAPSortSelectorInterface defines the basic methods required for the model of a OLAPSortSelector.

Field Summary

Fields inherited from interface com.sas.util.SortDirectionInterface

ASCENDING, DESCENDING, NOT_SORTED

Method Summary

javax.swing.tree.TreeModel	getAvailableCellValueItems()
javax.swing.tree.TreeModel	getAvailableLevelLabelItems() Returns the items in which sorting is allowed.
int[]	getSortedCellValueDirections()
javax.swing.tree.TreeModel	getSortedCellValueItems()
int[]	getSortedLevelLabelDirections() Returns an array of ints that indicate which direction each item in the sortItems Map is to be sorted.
javax.swing.tree.TreeModel	getSortedLevelLabelItems() Returns the items that the table is to sort.
boolean	isCellValueHierarchicalSort()
boolean	isCellValueSorting()
boolean	isLevelLabelHierarchicalSort()
boolean	isLevelLabelSorting()
void	setAvailableLevelLabelItems(javax.swing.tree.TreeModel items) Sets the items in which sorting is allowed and that are currently not sorted.
void	setCellValueHierarchicalSort(boolean hierarachicalSort)
void	setLevelLabelHierarchicalSort(boolean hierarachicalSort)
void	setSortedCellValueDirections(int[] sortedDirections)
void	setSortedCellValueItems(javax.swing.tree.TreeModel sortedItems)
void	setSortedLevelLabelDirections(int[] sortedDirections) Sets an array of ints that indicate which direction each item in the sortItems Map is to be sorted.
void	setSortedLevelLabelItems(javax.swing.tree.TreeModel sortedItems) Sets the items that the table is to sort.

Method Detail

isLevelLabelSorting

boolean isLevelLabelSorting()

setAvailableLevelLabelItems

void setAvailableLevelLabelItems(javax.swing.tree.TreeModel items)

Sets the items in which sorting is allowed and that are currently not sorted. A name/value pair is used to identify the items within the Map. The name is a unique value used to identify each item. The value is a label used for displaying the item.

Parameters:

items - a Map of items which sorting is allowed on but currently are not sorted

See Also:

getAvailableLevelLabelItems()

getAvailableLevelLabelItems

javax.swing.tree.TreeModel getAvailableLevelLabelItems()

Returns the items in which sorting is allowed. The availableItems contains all the item names in which sorting is allowed on the model, all other items are to be non-sortable. A name/value pair is used to identify the items within the Map. The name is a unique value used to identify each item. The value is a label used for displaying the item.

Returns:

A Map of items in which sorting is allowed.

getSortedLevelLabelItems

javax.swing.tree.TreeModel getSortedLevelLabelItems()

Returns the items that the table is to sort. The size of the Map can be from 0 to maxSortableItems. A name/value pair is used to identify the items within the Map. The name is a unique value used to identify each item. The value is a label used for displaying the item.

Returns:

A Map of items on which the data is sorted.

setSortedLevelLabelItems

void setSortedLevelLabelItems(javax.swing.tree.TreeModel sortedItems)

Sets the items that the table is to sort. The size of the Map will be from 0 to maxSortableItems. A name/value pair is used to identify the items within the Map. The name is a unique value used to identify each item. The value is a label used for displaying the item.

Parameters:

itemNames - a Map of item on which the data is sorted

getSortedLevelLabelDirections

int[] getSortedLevelLabelDirections()

Returns an array of ints that indicate which direction each item in the sortItems Map is to be sorted. The array will be the same size of the sortItems Map. Valid values are ASCENDING or DESCENDING.

Returns:

An array of ints that indicate which direction the sort items are to be sorted. Valid values are ASCENDING or DESCENDING.

setSortedLevelLabelDirections

void setSortedLevelLabelDirections(int[] sortedDirections)

Sets an array of ints that indicate which direction each item in the sortItems Map is to be sorted. The array will be the same size of the sortItems Map. Valid values are ASCENDING or DESCENDING.

Parameters:

directions - an array of ints that indicate which direction the sort items are to be sorted

isLevelLabelHierarchicalSort

boolean isLevelLabelHierarchicalSort()

setLevelLabelHierarchicalSort

void setLevelLabelHierarchicalSort(boolean hierarachicalSort)

isCellValueSorting

boolean isCellValueSorting()

getAvailableCellValueItems

javax.swing.tree.TreeModel getAvailableCellValueItems()

getSortedCellValueItems

javax.swing.tree.TreeModel getSortedCellValueItems()

setSortedCellValueItems

void setSortedCellValueItems(javax.swing.tree.TreeModel sortedItems)

getSortedCellValueDirections

int[] getSortedCellValueDirections()

setSortedCellValueDirections

void setSortedCellValueDirections(int[] sortedDirections)

isCellValueHierarchicalSort

boolean isCellValueHierarchicalSort()

setCellValueHierarchicalSort

void setCellValueHierarchicalSort(boolean hierarachicalSort)