oracle.dss.util
Interface DataDirector

All Known Subinterfaces:

CubeDataDirector, RelationalDataDirector

All Known Implementing Classes:

DataAccessAdapter, QueryDataDirector

public interface DataDirector

Methods and fields that are necessary for a view to manipulate data in the data provider.

Field Summary

static int	COLUMN_EDGE Column edge.
static int	DATA_ELEMENT_EDGE Data element edge.
static int	DRILL_REPLACE A flag indicating that a "replace-style" drill should be performed
static int	DRILLSTATE_DRILLABLE The hierarchy for the member can be drilled, that is, expanded to provide more detail.
static int	DRILLSTATE_IS_DRILLED The hierarchy for the member cannot be drilled, that is, expanded further.
static int	DRILLSTATE_NOT_DRILLABLE Not able to drill.
static int	GROUPSORT_END The cell marks the end of a group sort in a table.
static int	GROUPSORT_MIDDLE The cell is located in the middle of a group sort in a table.
static int	GROUPSORT_NONE The cell is not involved in a group sort in a table.
static int	GROUPSORT_START The cell marks the start of a group sort in a table.
static int	max_edge Maximum edge that views will use when calling DataAccess and DataDirector.
static int	NA_SUPPRESSION Suppress NA values.
static int	NA_ZERO_SUPPRESSION Suppress zeros and NA values.
static int	NO_SUPPRESSION Do not suppress any values.
static int	PAGE_EDGE Page edge.
static int	PIVOT_EDGES Swaps the specified edges.
static int	PIVOT_MOVE_AFTER Move the "from" layer after the "to" layer on the same or another edge.
static int	PIVOT_MOVE_BEFORE Move the "from" layer before the "to" layer on the same or another edge.
static int	PIVOT_MOVE_TO Move the "from" layer to the "to" layer on another edge.
static int	PIVOT_SWAP Swaps a layer from one location on an edge to another location on the same or another edge.
static int	ROW_EDGE Row edge.
static int	ZERO_SUPPRESSION Suppress zeros.

Method Summary

void	addDataDirectorListener(DataDirectorListener l) Registers a listener to the data source for changes.
boolean	cancel() Cancels the current long-running operation, if possible.
boolean	changeEdgeCurrentHPos(int edge, int[] hPos, int maxLayerSpecified) Changes the slice of data, on the specified edge, that is designated as the current slice by using hierarchical addressing.
boolean	changeEdgeCurrentSlice(int edge, int slice) Changes the slice, on the specified edge, that is designated as the current slice of data.
boolean	deleteMemberCalc(int edge, int layer, int slice) Deletes a calculation from the display based on a member that is located at the specified edge, layer, and slice.
boolean	deleteValueCalc(int row, int column) Deletes a calculation at the specified row and column of the body of a data for a view.
boolean	drill(int edge, int layer, int[] slice, int flags) Drills in data based on multiple selected members.
boolean	drill(int edge, int layer, int slice, int flags) Drills in the data for a single member.
boolean	drillOK(int edge, int layer, int[] slice, int flags) Indicates whether the specified drill operation from multiple selected members would be a valid drill.
boolean	drillOK(int edge, int layer, int slice, int flags) Indicates whether a drill operation from a single selected member would be legal.
DataMap	getDataMap() Retrieves the list of types of data that can be retrieved or set for each location in the data cursor.
MetadataMap	getMetadataMap(int edge, int layer) Retrieves the list of all the types of metadata that callers have requested to be included in the cursors for the specified logical layer.
DataMap	getSupportedDataMap() Retrieves a Datamap object that contains all data map types that are available for the definition of a data map.
LayerMetadataMap	getSupportedLayerMetadataMap() Retrieves a LayerMetadataMap object that contains all the types of layer metadata that are available for the definition of a layer metadata map.
MetadataMap	getSupportedMetadataMap() Retrieves a MetadataMap object that contains all the types of metadata that are available for the definition of a metadata map.
boolean	insertMemberCalc(int edge, int layer, int slice, int flags, java.lang.Object calc) Inserts a calculation into a display based on the member at the specified edge, layer, and slice.
boolean	insertValueCalc(int row, int column, int flags, java.lang.Object calc) Inserts a calculation at a specified row and column in the body of a view's data.
boolean	isCancelable() Indicates whether this DataDirector implementor allows views to cancel an operation that takes a long time.
boolean	isOutline() Indicates whether data is provided in outline form or inline form.
boolean	pivot(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) Pivots or swaps data.
boolean	pivotOK(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) Indicates whether the specified pivot operation would be valid for the current data layout.
boolean	refresh() Refreshes data and fires a DataChangedEvent to all registered listeners.
void	removeDataDirectorListener(DataDirectorListener l) Removes a listener from the data source.
boolean	reorder(int edge, int fromLayer, int toLayer, int flags) Reorders the layers (that is, columns) of a Table object.
boolean	revalidate() Rebuilds (that is, reruns) a query, refreshes the data cache, and fires a DataChangedEvent.
void	setDataMap(DataMap map, int sizeRow, int sizeColumn) Specifies the types of data to provide in a data cursor.
void	setManualUpdate() Batches DataDirector operations.
void	setMetadataMap(int edge, int layer, MetadataMap map, int size) Specifies the types of metadata to provide in the cursors for the specified logical layer.
void	setOutline(boolean outline) Specifies whether data is provided to a view in outline form.
void	update() Processes batched DataDirector operations.

Field Detail

COLUMN_EDGE

public static final int COLUMN_EDGE

Column edge.

ROW_EDGE

public static final int ROW_EDGE

Row edge.

PAGE_EDGE

public static final int PAGE_EDGE

Page edge.

DATA_ELEMENT_EDGE

public static final int DATA_ELEMENT_EDGE

Data element edge. This edge is defined for layout panels especially to indicate pivoting items from or to an extra central "edge" that can be used for any purpose by the implementor.

PIVOT_EDGES

public static final int PIVOT_EDGES

Swaps the specified edges. Ignores layers.

PIVOT_SWAP

public static final int PIVOT_SWAP

Swaps a layer from one location on an edge to another location on the same or another edge.

PIVOT_MOVE_BEFORE

public static final int PIVOT_MOVE_BEFORE

Move the "from" layer before the "to" layer on the same or another edge.

PIVOT_MOVE_AFTER

public static final int PIVOT_MOVE_AFTER

Move the "from" layer after the "to" layer on the same or another edge.

PIVOT_MOVE_TO

public static final int PIVOT_MOVE_TO

Move the "from" layer to the "to" layer on another edge. This should be used when the "to" edge has 0 layers.

NO_SUPPRESSION

public static final int NO_SUPPRESSION

Do not suppress any values.

ZERO_SUPPRESSION

public static final int ZERO_SUPPRESSION

Suppress zeros.

NA_SUPPRESSION

public static final int NA_SUPPRESSION

Suppress NA values.

NA_ZERO_SUPPRESSION

public static final int NA_ZERO_SUPPRESSION

Suppress zeros and NA values.

DRILLSTATE_NOT_DRILLABLE

public static final int DRILLSTATE_NOT_DRILLABLE

Not able to drill. Perhaps the member has no hierarchy. This is one of the constants that can be returned if the DataAccess.getMemberMetadata method is called with the parameter MetadataMap.METADATA_DRILLSTATE, which requests drill state information.

See Also:

DataAccess.getMemberMetadata(int, int, int, java.lang.String), MetadataMap.METADATA_DRILLSTATE

DRILLSTATE_DRILLABLE

public static final int DRILLSTATE_DRILLABLE

The hierarchy for the member can be drilled, that is, expanded to provide more detail. This is one of the constants that can be returned if the DataAccess.getMemberMetadata method is called with the parameter MetadataMap.METADATA_DRILLSTATE, which requests drill state information.

See Also:

DataAccess.getMemberMetadata(int, int, int, java.lang.String), MetadataMap.METADATA_DRILLSTATE

DRILLSTATE_IS_DRILLED

public static final int DRILLSTATE_IS_DRILLED

The hierarchy for the member cannot be drilled, that is, expanded further. You can drill up, that is, collapse levels of detail. This is one of the constants that can be returned if the DataAccess.getMemberMetadata method is called with the parameter MetadataMap.METADATA_DRILLSTATE, which requests drill state information.

See Also:

DataAccess.getMemberMetadata(int, int, int, java.lang.String), MetadataMap.METADATA_DRILLSTATE

GROUPSORT_NONE

public static final int GROUPSORT_NONE

The cell is not involved in a group sort in a table. This is one of the constants that can be returned if the DataAccess.getValue method is called with a type parameter equal to DataMap.DATA_GROUPSORT, which requests group sort information.

See Also:

DataAccess.getValue(int, int, java.lang.String), DataMap.DATA_GROUPSORT

GROUPSORT_START

public static final int GROUPSORT_START

The cell marks the start of a group sort in a table. This is one of the constants that can be returned if the DataAccess.getValue method is called with a type parameter equal to DataMap.DATA_GROUPSORT, which requests group sort information.

See Also:

DataAccess.getValue(int, int, java.lang.String), DataMap.DATA_GROUPSORT

GROUPSORT_MIDDLE

public static final int GROUPSORT_MIDDLE

The cell is located in the middle of a group sort in a table. This is one of the constants that can be returned if the DataAccess.getValue method is called with a type parameter equal to DataMap.DATA_GROUPSORT, which requests group sort information.

See Also:

DataAccess.getValue(int, int, java.lang.String), DataMap.DATA_GROUPSORT

GROUPSORT_END

public static final int GROUPSORT_END

The cell marks the end of a group sort in a table. This is one of the constants that can be returned if the DataAccess.getValue method is called with a type parameter equal to DataMap.DATA_GROUPSORT, which requests group sort information.

See Also:

DataAccess.getValue(int, int, java.lang.String), DataMap.DATA_GROUPSORT

max_edge

public static final int max_edge

Maximum edge that views will use when calling DataAccess and DataDirector. This constant is used by layout panels.

Typically, the maximum edge is PAGE_EDGE. Implementors can use edges with a value greater than this constant to "hide" qualifying logical layers from display by the views and, yet, keep these layers as part of their query for query manipulation.

DRILL_REPLACE

public static final int DRILL_REPLACE

A flag indicating that a "replace-style" drill should be performed

See Also:

drill(int, int, int, int), drillOK(int, int, int, int)

Method Detail

pivot

public boolean pivot(int fromEdge,
                     int toEdge,
                     int fromLayer,
                     int toLayer,
                     int flags)
              throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException

Pivots or swaps data. Operations include:

• Moving layers from one edge to another
• Moving layers from one location on an edge to another location on the same edge
• Swapping the locations of two layers
• Swapping two edges

Parameters:

fromEdge - A constant that indicates the edge from which a layer should be pivoted. Valid constants end with _EDGE in this interface.

toEdge - A constant that indicates the edge to which a layer should be pivoted. Valid constants end with _EDGE in this interface.

fromLayer - The zero-based index of the physical layer on the fromEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object will report columns as its layers.

toLayer - The zero-based index of the physical layer on the toEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object will report columns as its layers.

flags - A constant that indicates the type of pivot to perform. The constants begin with PIVOT_ in this interface.

Returns:

true if the pivot is successful, false if not.

Throws:

EdgeOutOfRangeException - If either edge is not valid.

LayerOutOfRangeException - If either layer is not valid.

DataDirectorException - If an error occurs during the operation.

See Also:

COLUMN_EDGE, DATA_ELEMENT_EDGE, PAGE_EDGE, ROW_EDGE, PIVOT_EDGES, PIVOT_MOVE_AFTER, PIVOT_MOVE_BEFORE, PIVOT_MOVE_TO, PIVOT_SWAP

pivotOK

public boolean pivotOK(int fromEdge,
                       int toEdge,
                       int fromLayer,
                       int toLayer,
                       int flags)
                throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException

Indicates whether the specified pivot operation would be valid for the current data layout. This method is called before the pivot method and does not perform the actual pivot. The data provider determines its own rules for valid pivot operations.

Parameters:

fromEdge - A constant that indicates the edge from which a layer should be pivoted. Valid constants end with _EDGE in this interface.

toEdge - A constant that indicates the edge to which a layer should be pivoted. Valid constants end with _EDGE in this interface.

fromLayer - The zero-based index of the physical layer on the fromEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object will report columns as its layers.

toLayer - The zero-based index of the physical layer on the toEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object will report columns as its layers.

flags - A constant that indicates the type of pivot to perform. The constants begin with PIVOT_ in this interface.

Returns:

true if the pivot is legal according to the data provider's rules, false if the pivot is not legal according to the data provider's rules.

Throws:

EdgeOutOfRangeException - If either edge is too large.

LayerOutOfRangeException - If either layer is negative or too large.

DataDirectorException - If a data provider error occurs.

See Also:

COLUMN_EDGE, DATA_ELEMENT_EDGE, PAGE_EDGE, ROW_EDGE, PIVOT_EDGES, PIVOT_MOVE_AFTER, PIVOT_MOVE_BEFORE, PIVOT_MOVE_TO, PIVOT_SWAP

drill

public boolean drill(int edge,
                     int layer,
                     int slice,
                     int flags)
              throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException

Drills in the data for a single member.

Parameters:

edge - A constant that indicates the edge to drill. Valid constants end with _EDGE in this interface.

layer - The zero-based index of the physical layer of the member to be drilled. The outermost layer on the edge is 0.

slice - The zero-based index (along the specified edge) of the slice that represents the member that is to be drilled. Each member in the innermost layer has a unique slice. In outer layers, any slice that the member spans can be used.

flags - Not yet defined.

Returns:

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

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

DataDirectorException - If a data provider error occurs.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

drillOK

public boolean drillOK(int edge,
                       int layer,
                       int slice,
                       int flags)
                throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException

Indicates whether a drill operation from a single selected member would be legal. This method is called before the drill method and does not perform the actual drill.

Parameters:

edge - A constant that indicates the edge to drill. Valid constants end with _EDGE in this interface.

layer - The zero-based index of the physical layer of the member that is to be drilled. The outermost layer on the edge is 0.

slice - The zero-based index (along the specified edge) of the slice that represents the members that are to be drilled. Each member in the innermost layer has a unique slice. In outer layers, any slice that the member spans can be used.

flags - Not yet defined.

Returns:

true if the specified drilling operation is legal, false if the specified operation is not legal.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

DataDirectorException - If an error occurs during the drilling operation.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

drill

public boolean drill(int edge,
                     int layer,
                     int[] slice,
                     int flags)
              throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException

Drills in data based on multiple selected members.

Parameters:

edge - A constant that indicates the edge to drill. Valid constants end with _EDGE in this interface.

layer - The zero-based index of the physical layer of the members to be drilled. The outermost layer on the edge is 0.

slice - A list of the zero-based indexes (along the specified edge) of the slices that represent the members that are to be drilled. Each member in the innermost layer has a unique slice. In outer layers, any slice that the member spans can be used.

flags - Not yet defined.

Returns:

true if the drill operation is successful, false if the drill operation is not successful.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

DataDirectorException - If a data provider error occurs.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

drillOK

public boolean drillOK(int edge,
                       int layer,
                       int[] slice,
                       int flags)
                throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException

Indicates whether the specified drill operation from multiple selected members would be a valid drill. This method is called before the drill method and does not perform the actual drill.

Parameters:

edge - A constant that indicates the edge to drill. Valid constants end with _EDGE in this interface.

layer - The zero-based index of the physical layer of the member to be drilled. The outermost layer on the edge is 0.

slice - A list of the zero-based indexes (along the specified edge) of the slices that represent the members that are to be drilled. Each member in the innermost layer has a unique slice. In outer layers, any slice that the member spans can be used.

flags - Not yet defined.

Returns:

true if this drilling operation is legal, false if not.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

DataDirectorException - If a data provider error occurs.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

changeEdgeCurrentSlice

public boolean changeEdgeCurrentSlice(int edge,
                                      int slice)
                               throws EdgeOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException

Changes the slice, on the specified edge, that is designated as the current slice of data. This method uses the slice parameter to indicate the new current slice.

Parameters:

edge - A constant that indicates the edge on which to change the current slice. Valid constants end with _EDGE in this interface.

slice - The zero-based index (along the specified edge) of the slice that is to become the current slice.

Returns:

true if the change is successful, false if the change is not successful.

Throws:

EdgeOutOfRangeException - If edge is too large.

SliceOutOfRangeException - If slice is too large.

DataDirectorException - If a data provider error occurs.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

changeEdgeCurrentHPos

public boolean changeEdgeCurrentHPos(int edge,
                                     int[] hPos,
                                     int maxLayerSpecified)
                              throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException

Changes the slice of data, on the specified edge, that is designated as the current slice by using hierarchical addressing. This method is generally used when paging controls change the current page of a view.

Parameters:

edge - A constant that indicates the edge on which to make the change. Valid constants end with _EDGE in this interface.

hPos - An array of relative indexes starting with the outermost layer and working in at least to maxLayerSpecified. This array indicates the set of new values to give to the various layers that specify the new current slice.

maxLayerSpecified - The maximum index into hPos (layer) that this method should use in making the change to the current slice.

Returns:

true if the current slice change is successful, false if the current slice change is not successful.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If the number of layers in hPos is too large.

SliceOutOfRangeException - If the indexes in the hPos are out of range.

DataDirectorException - If an error occurs during the operation.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

reorder

public boolean reorder(int edge,
                       int fromLayer,
                       int toLayer,
                       int flags)
                throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException

Reorders the layers (that is, columns) of a Table object. The flags parameter uses the pivot constants from this interface to specify the operation that is to be performed. These constants are as follows:

• PIVOT_SWAP -- Swaps fromLayer with toLayer.
• PIVOT_MOVE_BEFORE -- Moves fromLayer before toLayer.
• PIVOT_MOVE_AFTER -- Moves fromLayer after toLayer.

Parameters:

edge - A constant that identifies the edge on which the reorder takes place. Valid constants end with _EDGE in this interface.

fromLayer - The zero-based index of the physical layer (column) that the Table object wants to move. The outermost layer on the edge is 0.

toLayer - The zero-based index of the physical layer (column) with which or to which the Table object is moving the fromLayer. The outermost layer on the edge is 0.

flags - A constant that indicates the operation to be performed. The constants begin with PIVOT_ in this interface.

Returns:

true if reordering is successful, false if reordering is not successful.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

DataDirectorException - If an error occurs during the operation.

See Also:

COLUMN_EDGE, PAGE_EDGE, PIVOT_MOVE_AFTER, PIVOT_MOVE_BEFORE, PIVOT_SWAP, ROW_EDGE

insertValueCalc

public boolean insertValueCalc(int row,
                               int column,
                               int flags,
                               java.lang.Object calc)
                        throws RowOutOfRangeException,
ColumnOutOfRangeException,
DataDirectorException

Inserts a calculation at a specified row and column in the body of a view's data.

Parameters:

row - The row at which to insert the calculation.

column - The column at which to insert the calculation.

flags - Not yet defined.

calc - Not yet defined.

Returns:

true if the calculation is inserted, false if the calculation is not inserted.

Throws:

RowOutOfRangeException - If row is negative or too large.

ColumnOutOfRangeException - If column is negative or too large.

DataDirectorException - If an error occurs during the operation.

insertMemberCalc

public boolean insertMemberCalc(int edge,
                                int layer,
                                int slice,
                                int flags,
                                java.lang.Object calc)
                         throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException

Inserts a calculation into a display based on the member at the specified edge, layer, and slice.

Parameters:

edge - A constant that specifies the edge that contains the member at which to insert the calculation. Valid constants end with _EDGE in this interface.

layer - The zero-based index of the physical layer that contains the member at which to insert the calculation. The outermost layer on the edge is 0.

slice - The zero-based index (along the specified edge) of the slice at which to insert the calculation.

flags - Not yet defined.

calc - Not yet defined.

Returns:

true if the calculation is inserted, false if the calculation is not inserted.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

DataDirectorException - If an error occurs during the operation.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

deleteValueCalc

public boolean deleteValueCalc(int row,
                               int column)
                        throws RowOutOfRangeException,
ColumnOutOfRangeException,
DataDirectorException

Deletes a calculation at the specified row and column of the body of a data for a view. Deletes the calculation only if it is present at the specified location.

Parameters:

row - The row at which to delete the calculation.

column - The column at which to delete the calculation.

Returns:

true if the calculation is deleted, false if the calculation is not deleted.

Throws:

RowOutOfRangeException - If row is negative or too large.

ColumnOutOfRangeException - If column is negative or too large.

DataDirectorException - If an error occurs during the operation.

deleteMemberCalc

public boolean deleteMemberCalc(int edge,
                                int layer,
                                int slice)
                         throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException

Deletes a calculation from the display based on a member that is located at the specified edge, layer, and slice. Deletes the calculation only if it is present at the specified location.

Parameters:

edge - A constant that specifies the edge that contains the member for which to delete the calculation. Valid constants end with _EDGE in this interface.

layer - The zero-based index of the physical layer that contains the member for which to delete the calculation. The outermost layer on the edge is 0.

slice - The zero-based index (along the specified edge) of the slice at which to delete the calculation.

Returns:

true if the calculation is deleted, false if the calculation is not deleted.

Throws:

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

DataDirectorException - If an error occurs during the operation.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

addDataDirectorListener

public void addDataDirectorListener(DataDirectorListener l)

Registers a listener to the data source for changes. The DataDirector implementor is expected to fire a DataAvailableEvent in this routine when data is available and to provide an implementation of the DataAccess interface when data is ready.

Parameters:

l - The listener to add.

removeDataDirectorListener

public void removeDataDirectorListener(DataDirectorListener l)

Removes a listener from the data source.

Parameters:

l - The listener to remove.

refresh

public boolean refresh()
                throws DataDirectorException

Refreshes data and fires a DataChangedEvent to all registered listeners. This method signals the implementor to refresh the data cache without rerunning the query.

Returns:

true if data will be refreshed, false if data will not be refreshed.

Throws:

DataDirectorException - If an error occurs during the operation.

revalidate

public boolean revalidate()
                   throws DataDirectorException

Rebuilds (that is, reruns) a query, refreshes the data cache, and fires a DataChangedEvent.

Returns:

true if data will be refreshed, false if data will not be refreshed.

Throws:

DataDirectorException - If an error occurs during the operation.

setOutline

public void setOutline(boolean outline)
                throws DataDirectorException

Specifies whether data is provided to a view in outline form. Updates the data and fires a DataChanged event. This is an optional method because implementors that do not require an outline display do not have to support outline form. Outline form lists outer layers in the same depth as inner layers, whereas inline form shows outer layers at different depths.

For example, if the row edge uses outline form, all layers appear in the same label column. If the row edge does not use outline form, then there is a separate column for each layer.

Parameters:

outline - true to specify outline form for data, false to use inline form for data.

Throws:

DataDirectorException - If a data provider error occurs.

isOutline

public boolean isOutline()

Indicates whether data is provided in outline form or inline form. Outline form lists outer layers in the same depth as inner layers, whereas inline form shows outer layers at different depths. This method should always return false if the implementor does not support outline form.

In a Crosstab, for example, if a row edge uses outline form, then all layers appear in the same label column. If a row edge does not use outline form, then there is a separate column for each layer.

Returns:

true if the data is provided in outline form, false if the data is provided in inline form.

setMetadataMap

public void setMetadataMap(int edge,
                           int layer,
MetadataMap map,
                           int size)
                    throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException

Specifies the types of metadata to provide in the cursors for the specified logical layer.

Parameters:

edge - A constant that indicates the edge that contains the logical layer of interest. Valid constants end with _EDGE in this interface. To set a default map for all edges, pass -1.

layer - The index for the logical layer whose MetadataMap is to be set. To refer to all of the layers on an edge, use -1.

map - A list of the metadata types that the implementor should fetch for the specified layer, if possible.

size - A suggested number of metatdata values that the data provider should fetch at a time. This is a guide for the data provider about the size of metadata chunks. This parameter is ignored if the implementor does not support partial fetches.

Throws:

EdgeOutOfRangeException - If edge is out of range.

LayerOutOfRangeException - If layer is out of range.

DataDirectorException - If a data provider error occurs.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

setDataMap

public void setDataMap(DataMap map,
                       int sizeRow,
                       int sizeColumn)
                throws DataDirectorException

Specifies the types of data to provide in a data cursor.

Parameters:

map - A list of the data types that the caller expects in data cursors that the DataAccess implementation fetches.

sizeRow - The suggested number of rows that the data provider should fetch at a time.

sizeColumn - The suggested number of columns that the data provider should fetch at a time.

Throws:

DataDirectorException - If a data provider error occurs.

getMetadataMap

public MetadataMap getMetadataMap(int edge,
                                  int layer)
                           throws EdgeOutOfRangeException,
LayerOutOfRangeException

Retrieves the list of all the types of metadata that callers have requested to be included in the cursors for the specified logical layer. This list includes the types of metadata that have been specified in setMetadataMap requests by any views that use this data provider.

Parameters:

edge - A constant that indicates the edge that contains the logical layer. Valid constants end with _EDGE in this interface. A value of -1 is a request for the default MetadataMap.

layer - A zero-based index for the logical layer for which to retrieve the metadata map. The outermost layer on the specified edge is zero. A layer value of -1 indicates all of the layers on the specified edge.

Returns:

The map that contains all of the types of metadata that are to be retrieved into the cursors for the layer.

Throws:

EdgeOutOfRangeException - If edge is out of range.

LayerOutOfRangeException - If layer is not valid.

See Also:

COLUMN_EDGE, PAGE_EDGE, ROW_EDGE

getDataMap

public DataMap getDataMap()

Retrieves the list of types of data that can be retrieved or set for each location in the data cursor. This list includes the types of data that have been specified in data maps by any views that use this data provider.

Returns:

The map of available types of data.

getSupportedMetadataMap

public MetadataMap getSupportedMetadataMap()

Retrieves a MetadataMap object that contains all the types of metadata that are available for the definition of a metadata map. This is not meant to guarantee views that they can get all the supported types in every query.

Returns:

A MetadataMap object that contains all possible supported metadata types.

See Also:

MetadataMap

getSupportedLayerMetadataMap

public LayerMetadataMap getSupportedLayerMetadataMap()

Retrieves a LayerMetadataMap object that contains all the types of layer metadata that are available for the definition of a layer metadata map. This is not meant to guarantee views that they can get all the supported types in every query.

Returns:

A LayerMetadataMap object that contains all possible supported layer metadata types.

See Also:

LayerMetadataMap

getSupportedDataMap

public DataMap getSupportedDataMap()

Retrieves a Datamap object that contains all data map types that are available for the definition of a data map. This is not meant to guarantee views that they can get all the supported types in every query.

Returns:

A DataMap object that contains all possible supported data map types.

See Also:

DataMap

isCancelable

public boolean isCancelable()

Indicates whether this DataDirector implementor allows views to cancel an operation that takes a long time.

Returns:

true if the data provider supports cancelation of long operations, false if not.

cancel

public boolean cancel()
               throws DataDirectorException

Cancels the current long-running operation, if possible.

Returns:

true if the implementor canceled the operation, false if the implementor did not or could not cancel the operation.

Throws:

DataDirectorException - If a data provider error occurs.

setManualUpdate

public void setManualUpdate()

Batches DataDirector operations. If the implementor supports command batching, then operations between this call and a call to update are batched.

See Also:

update()

update

public void update()
            throws DataDirectorException

Processes batched DataDirector operations. Operations between a call to setManualUpdate and this method are batched. This method should also turn off manual update mode.

Throws:

DataDirectorException - If a data provider error occurs.

See Also:

setManualUpdate()