oracle.dss.thin.beans.tools.query
Class SortTool

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.tools.BaseViewTool
              |
              +--oracle.dss.thin.beans.tools.query.SortTool

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI, ViewTool

public class SortTool

extends BaseViewTool

SortTool is used to sort a Selection for a selected dimension of the View. SortTool can be used standalone or with oracle.dss.thin.beans.toolbar.ViewToolbar.

For the SortTool to function properly:

• the DataSource of the View needs to extend oracle.dss.dataSource.Query. For details, see Query.
• the View needs to be a ThinCrosstab or a ThinGraph. Sorting is not supported on ThinTables.

The SortTool generates the following events:

• BIConstants.SORT_EVENT -- generated by pressing the "Go" button.

The SortTool handles the following events:

• BIConstants.SORT_EVENT -- generated by pressing the "Go" button.
  When this event occurs, the SortTool sorts the selected dimension of the tool's View by adding the ConditionSortStep to that dimension's Selection

For more information about using the SortTool, see the "Sort Tool" topic in the BI Beans Help system.

See Also:

Selection, ConditionSortStep, Query, ViewTool, ViewToolbar

Field Summary

static java.lang.String	ALPHABETICAL_SORT
static java.lang.String	ASCENDING_SORT
static java.lang.String	CHRONOLOGICAL_SORT
static java.lang.String	DESCENDING_SORT
static java.lang.String	HIERARCHICAL_SORT
static java.lang.String	MEASURE_SORT
static java.lang.String	SEPARATOR

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

SortTool()
Constructor.

Method Summary

oracle.cabo.ui.UINode	getContentUINode() Retrieves the UINode used to render this ViewTool
java.lang.String	getDisplayName() Retrieves the name used to display this tool on the ViewToolbar
java.lang.String	getSortDimension() Retrieves the dimension for the SortTool.
java.lang.String	getSortMeasure() Retrieves the measure for the SortTool.
java.lang.String	getSortOrder() Retrieves the order for the SortTool.
int	getSortQualifierEdge() Retrieves the edge for the sort criterion.
int	getSortQualifierSlice() Retrieves the sort criterion slice.
java.lang.String	getSortType() Retrieves the sort type for the SortTool.
int	handleEvent(QueryParameterProvider provider) An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request.
boolean	isEnabled() Indicates whether the SortTool's link appears on the toolbar.
void	setSortDimension(java.lang.String dimension) Specifies the dimension for the SortTool.
void	setSortMeasure(java.lang.String measure) Specifies the measure for the SortTool.
void	setSortOrder(java.lang.String order) Specifies the sort order for the SortTool.
void	setSortQualifierEdge(int edge) Specifies the edge for the sort criterion.
void	setSortQualifierSlice(int slice) Specifies the sort criterion slice.
void	setSortType(java.lang.String type) Specifies the type of sorting for the SortTool.

Methods inherited from class oracle.dss.thin.beans.tools.BaseViewTool

addViewToolListener, getDestination, getToolbarName, getView, isVisible, removeViewToolListener, setDestination, setDisplayName, setEnabled, setToolbarName, setView, setVisible

Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI

addErrorHandler, checkpointState, generateOnClickSubmit, getCheckpointState, getEventTarget, getLocale, getState, getThinBeanName, removeErrorHandler, setBaseState, setCheckpointState, setEventTarget, setLocale, setState, setThinBeanName

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.thin.beans.ThinBeanUI

getEventTarget, getLocale, setEventTarget, setLocale

Methods inherited from interface oracle.dss.thin.beans.ThinBean

getState, getThinBeanName, setBaseState, setState, setThinBeanName

Field Detail

ALPHABETICAL_SORT

public static final java.lang.String ALPHABETICAL_SORT

HIERARCHICAL_SORT

public static final java.lang.String HIERARCHICAL_SORT

CHRONOLOGICAL_SORT

public static final java.lang.String CHRONOLOGICAL_SORT

MEASURE_SORT

public static final java.lang.String MEASURE_SORT

ASCENDING_SORT

public static final java.lang.String ASCENDING_SORT

DESCENDING_SORT

public static final java.lang.String DESCENDING_SORT

SEPARATOR

public static final java.lang.String SEPARATOR

Constructor Detail

SortTool

public SortTool()

Constructor.

Method Detail

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request. To determine the correct ThinBean to call handleEvent() on, the application should check the "source" query parameter, which will be the ThinBeanName of the ThinBean that rendered the URL/Form in HTML and which also needs to handle the event. The application can also choose to call handleEvent on all of its ThinBeanUI components and check the return value of handleEvent() to determine which component has handled the event. Each ThinBeanUI component needs to check the source parameter to make sure that it matches their ThinBeanName. If it does not match, then the event should not be processed.

Parameters:

provider - An instance of a QueryParameterProvider that returns decoded and unescaped query parameter values from HTTPServletRequests

Returns:

EVENT_NOT_HANDLED, EVENT_HANDLED, or EVENT_RESPONSE_DONE

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE

getSortDimension

public java.lang.String getSortDimension()

Retrieves the dimension for the SortTool.

Returns:

the name of the current dimension as a String

setSortDimension

public void setSortDimension(java.lang.String dimension)

Specifies the dimension for the SortTool.

Parameters:

current - dimension String name

getSortMeasure

public java.lang.String getSortMeasure()

Retrieves the measure for the SortTool. The measure is used only if the sort type is SortTool.MEASURE_SORT.

Returns:

the unique name of the measure as a String

setSortMeasure

public void setSortMeasure(java.lang.String measure)

Specifies the measure for the SortTool. The measure is used only if the sort type is SortTool.MEASURE_SORT.

Parameters:

unique - String name of the measure

setSortType

public void setSortType(java.lang.String type)

Specifies the type of sorting for the SortTool.

Parameters:

sort - type: ALPHABETICAL_SORT, CHRONOLOGICAL_SORT, or MEASURE_SORT

getSortType

public java.lang.String getSortType()

Retrieves the sort type for the SortTool.

Returns:

the sort type as a String

getSortOrder

public java.lang.String getSortOrder()

Retrieves the order for the SortTool.

Returns:

the sort order

setSortOrder

public void setSortOrder(java.lang.String order)

Specifies the sort order for the SortTool.

Parameters:

the - order

getSortQualifierEdge

public int getSortQualifierEdge()

Retrieves the edge for the sort criterion.

Returns:

the edge of the sort criterion

setSortQualifierEdge

public void setSortQualifierEdge(int edge)

Specifies the edge for the sort criterion.

Parameters:

the - edge of the sort criterion

getSortQualifierSlice

public int getSortQualifierSlice()

Retrieves the sort criterion slice.

Returns:

the sort criterion slice

setSortQualifierSlice

public void setSortQualifierSlice(int slice)

Specifies the sort criterion slice.

Parameters:

the - sort criterion slice

getContentUINode

public oracle.cabo.ui.UINode getContentUINode()

Retrieves the UINode used to render this ViewTool

Returns:

UINode used to render this view tool

getDisplayName

public java.lang.String getDisplayName()

Retrieves the name used to display this tool on the ViewToolbar

Overrides:

getDisplayName in class BaseViewTool

Returns:

tool display name

See Also:

ViewToolbar

isEnabled

public boolean isEnabled()

Indicates whether the SortTool's link appears on the toolbar. When the current View's DataSource is not an instance of an OLAP Query, the SortTool becomes disabled and does not appear on the toolbar.

Overrides:

isEnabled in class BaseViewTool

Returns:

true if enabled, false otherwise

See Also:

ViewToolbar