oracle.dss.util
Interface LayoutContext

All Known Implementing Classes:

Query

public interface LayoutContext

Methods that provide the layout panels a way to get LayoutAccess objects and to apply them to a query. Layout panels in the user interface for the beans call these methods.

The object that implements this interface must also implement the DataSource interface. If your application uses the QueryBuilder and the Layout panels, then the object that implements this interface must also implement the QueryContext interface.

The implementation of this interface must handle its own initialization issues.

See Also:

DataSource, QueryContext, Layout

Method Summary

boolean	applyLayoutAccess(LayoutAccess la, boolean update) Updates the LayoutContext data source with changed layout information.
LayoutAccess	createCubeLayoutAccess() Creates an implementation of the LayoutAccess interface that presents data with a cube layout.
LayoutAccess	createLayoutAccess() Deprecated. As of 2.4.0.14, replaced by createCubeLayoutAccess()
LayoutAccess	createRelationalLayoutAccess() Creates an implementation of the LayoutAccess interface that presents data with a relational (table) layout.

Method Detail

createLayoutAccess

public LayoutAccess createLayoutAccess()

Deprecated. As of 2.4.0.14, replaced by createCubeLayoutAccess()

Creates an implementation of the LayoutAccess interface.

Returns:

An object that implements the LayoutAccess interface.

createCubeLayoutAccess

public LayoutAccess createCubeLayoutAccess()

Creates an implementation of the LayoutAccess interface that presents data with a cube layout.

Returns:

An object that implements the LayoutAccess interface.

createRelationalLayoutAccess

public LayoutAccess createRelationalLayoutAccess()

Creates an implementation of the LayoutAccess interface that presents data with a relational (table) layout.

Returns:

An object that implements the LayoutAccess interface.

applyLayoutAccess

public boolean applyLayoutAccess(LayoutAccess la,
                                 boolean update)

Updates the LayoutContext data source with changed layout information. The implementation must ensure that the LayoutAccess that is passed to this method has enough information to initialize and run a query.

If the update parameter is true, then the implementer should do what is necessary to run the query with the new layout state.

Parameters:

la - LayoutAccess object to apply. la must have been created by the createLayoutAccess method of this LayoutContext.

update - true if the caller is finished with all the updates, false if the caller is not finished with the updates to this data source.

Returns:

true if la is successfully applied to the original query, false if la could not be applied.