oracle.dss.util
Class ColumnSortInfo

java.lang.Object
  oracle.dss.util.SortInfo
      oracle.dss.util.ColumnSortInfo

All Implemented Interfaces:

oracle.dss.util.parameters.ParameterUser

public class ColumnSortInfo
extends SortInfo

Class specifying one or more sets of direction, type, and hidden dimension item sort criteria for use in the setColumnSort API. Note that the base class SortInfo data and direction array settings should be single element arrays here.

Field Summary

protected boolean	m_grouped
protected boolean	m_hidden
protected int	m_type

Fields inherited from class oracle.dss.util.SortInfo

ASCENDING, DESCENDING, FIRST, LAST, m_direction, m_layerName, m_parameterHelper

Constructor Summary

ColumnSortInfo()
Constructor

ColumnSortInfo(java.lang.String layerName, int direction, boolean grouped)
Constructor

ColumnSortInfo(java.lang.String layerName, int direction, int type, boolean hidden)
Deprecated. As of 11.0.0.0.2, replaced by ColumnSortInfo(String, int, boolean)

Method Summary

boolean	equals(java.lang.Object obj)
boolean	getHidden() Deprecated. As of 11.0.0.0.2
int	getType() Deprecated. As of 11.0.0.0.2
boolean	isGrouped() Retrieves whether this column should be group sorted
void	setGrouped(boolean grouped) Specifies whether this column should be group sorted
void	setHidden(boolean hidden) Deprecated. As of 11.0.0.0.2
void	setType(int type) Deprecated. As of 11.0.0.0.2

Methods inherited from class oracle.dss.util.SortInfo

associateParameter, getAssociatedParameterName, getDirection, getLayerName, getParameterNames, parameterize, setDirection, setLayerName, usesParameter

Methods inherited from class java.lang.Object

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

Field Detail

m_type

protected int m_type

For internal use only. Application developers should not use this

m_hidden

protected boolean m_hidden

For internal use only. Application developers should not use this

m_grouped

protected boolean m_grouped

For internal use only. Application developers should not use this

Constructor Detail

ColumnSortInfo

public ColumnSortInfo()

Constructor

ColumnSortInfo

public ColumnSortInfo(java.lang.String layerName,
                      int direction,
                      int type,
                      boolean hidden)

Deprecated. As of 11.0.0.0.2, replaced by ColumnSortInfo(String, int, boolean)

Constructor

Parameters:

layerName - name of the layer to which these sort criteria apply

direction - Array of QDR objects by which to sort.

type - One of the sort type constants defined below.

hidden - true if column should be hidden.

ColumnSortInfo

public ColumnSortInfo(java.lang.String layerName,
                      int direction,
                      boolean grouped)

Constructor

Parameters:

layerName - The column to sort

direction - The direction in which to sort

grouped - Indicates whether the column should be group sorted

Method Detail

setType

public void setType(int type)

Deprecated. As of 11.0.0.0.2

Set the sort type the corresponding sort criteria.

Parameters:

type - One of the sort type constants defined below.

getType

public int getType()

Deprecated. As of 11.0.0.0.2

Get the sort type constant that specifies the sort type of the dimension item.

Returns:

Sort type constant.

setHidden

public void setHidden(boolean hidden)

Deprecated. As of 11.0.0.0.2

Set the hidden state for the dimension item. A value of true indicates that the column on which the sort takes place should be hidden.

Parameters:

hidden - true if column should be hidden.

getHidden

public boolean getHidden()

Deprecated. As of 11.0.0.0.2

Get the hidden state for the dimension item.

Returns:

true if item is hidden.

setGrouped

public void setGrouped(boolean grouped)

Specifies whether this column should be group sorted

Parameters:

grouped - true for a group sort, false otherwise.

isGrouped

public boolean isGrouped()

Retrieves whether this column should be group sorted

Returns:

true for a group sort, false otherwise.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SortInfo