oracle.dss.dataSource.common
Interface LayoutManager

All Superinterfaces:

BaseManager

All Known Implementing Classes:

Query, QueryServer

public interface LayoutManager

extends BaseManager

Defines methods that manipulate the mapping of dimensions along edges of an n-dimensional cube.

Method Summary

java.lang.String[][]	getLayout() Retrieves the current layout of dimensions in the Query object as a two-dimensional String.
java.lang.Boolean	layout(java.lang.String[][] dimensions) Arranges a layout of dimensions along the edges of a Query object.
void	pivot(java.lang.String source, java.lang.String target, int flags) Performs the specified pivot operation.
void	swap(java.lang.String source, java.lang.String target) Performs the specified swap operation.
void	swapEdges(int source, int target) Performs the specified edge swap operation.

Methods inherited from interface oracle.dss.dataSource.common.BaseManager

addQueryListener, cancel, clone, getFetchPageEdge, getFetchSize, getQueryState, getSuppressionState, isAsymmetricDrilling, isAutoUpdate, isEvaluateCursor, isHierarchicalDrilling, isUpdatePending, removeQueryListener, setAsymmetricDrilling, setAutoUpdate, setEvaluateCursor, setFetchPageEdge, setFetchSize, setHierarchicalDrilling, setQueryState, setSuppressionState, update

Method Detail

layout

public java.lang.Boolean layout(java.lang.String[][] dimensions)
                         throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Arranges a layout of dimensions along the edges of a Query object.

Parameters:

dimensions - An array of dimension layout arrays. The outer array maps to edges (such as column or row); the inner array maps slowest to fastest varying within an edge.

Returns:

true if the operation is successful; false if the operation is not successful.

Throws:

InvalidStepArgException - If a step in a selection is bad.

SelectionException - If a selection cannot be created.

QueryException - If there is a problem fetching data after this operation.

MetadataManagerException - If an error occurred using the MetadataManager bean.

pivot

public void pivot(java.lang.String source,
                  java.lang.String target,
                  int flags)
           throws InvalidStepArgException,
QueryException,
SelectionException,
MetadataManagerException

Performs the specified pivot operation.

Parameters:

source - The source dimension.

target - The target dimension (if an edge is empty, then this must be a number that indicates the target edge)

flags - A constant that indicates the type of pivot. Use PivotConstants.PIVOT_AFTER or PivotConstants.PIVOT_BEFORE.

Throws:

InvalidStepArgException - If a step in a selection is bad.

SelectionException - If a selection can't be created.

QueryException - If there is a problem fetching data after this operation.

MetadataManagerException - If an error occurred using the MetadataManager bean.

See Also:

PivotConstants.PIVOT_AFTER, PivotConstants.PIVOT_BEFORE

swap

public void swap(java.lang.String source,
                 java.lang.String target)
          throws InvalidStepArgException,
QueryException,
SelectionException,
MetadataManagerException

Performs the specified swap operation.

Parameters:

source - The source dimension.

target - The target dimension.

Throws:

InvalidStepArgException - If a step in a selection is bad.

SelectionException - If a selection cannot be created.

QueryException - If there is a problem fetching data after this operation.

MetadataManagerException - If an error occurred using the MetadataManager bean.

swapEdges

public void swapEdges(int source,
                      int target)
               throws InvalidStepArgException,
QueryException,
SelectionException,
MetadataManagerException

Performs the specified edge swap operation.

Parameters:

source - A constant (DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE) that represents the source edge.

target - A constant (DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE) that represents the target edge.

Throws:

InvalidStepArgException - If a step in a selection is bad.

SelectionException - If a selection can't be created.

QueryException - If there is a problem fetching data after this operation.

MetadataManagerException - If an error occurred using the MetadataManager bean.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getLayout

public java.lang.String[][] getLayout()

Retrieves the current layout of dimensions in the Query object as a two-dimensional String.

Returns:

The current layout of the Query object.