|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Model
Methods and fields required for a model. Most developers will use the BI Beans implementations of this interface and of the interfaces that extend this interface.
Field Summary | |
---|---|
static int |
VIEW_PAGE_FIRST Go to the first page. |
static int |
VIEW_PAGE_LAST Go to the last page. |
static int |
VIEW_PAGE_NEXT Go to the next page. |
static int |
VIEW_PAGE_PREVIOUS Go to the previous page. |
Method Summary | |
---|---|
void |
addDataListener(DataListener l) Registers a data listener with this model. |
void |
addModelListener(ModelListener l) |
boolean |
canDrill(java.lang.Object source, int edge, int layer, int slice, int flags) |
boolean |
canPivot(java.lang.Object source, int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) |
boolean |
drillGestureHappened(java.lang.Object source, int edge, int layer, int slice, int flags) |
ControllerActions |
getControllerActions() |
DataAccess |
getDataAccess() Get the data access for this view. |
DataDirector |
getDataDirector() Retrieves the data director for this view. |
DataSource |
getDataSource() Retrieves the data source for this view. |
ErrorHandler |
getErrorHandler() |
boolean |
isDrillingEnabled() Indicates whether drilling is allowed in this view. |
boolean |
pageChangeHappened(java.lang.Object source, int pos) |
boolean |
pageChangeHappened(java.lang.Object source, int[] hPos, int maxLayerSpecified) |
boolean |
pivotGestureHappened(java.lang.Object source, int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) |
void |
removeDataListener(DataListener l) Removes the data listener from this model. |
void |
removeModelListener(ModelListener l) |
void |
setDataAccess(DataAccess dp) Specifies the data access for this view. |
void |
setDataDirector(DataDirector dd) Specifies the data director for this view. |
void |
setDataSource(DataSource ds) Specifies the data source for this view. |
void |
setDrillingEnabled(boolean b) Specifies whether drilling is allowed in this view. |
void |
setErrorHandler(ErrorHandler eh) |
void |
viewDataChanged(DataChangedEvent e) |
Field Detail |
---|
static final int VIEW_PAGE_FIRST
static final int VIEW_PAGE_LAST
static final int VIEW_PAGE_PREVIOUS
static final int VIEW_PAGE_NEXT
Method Detail |
---|
void addModelListener(ModelListener l)
l
- The listener to add.void removeModelListener(ModelListener l)
l
- The listener to remove.void addDataListener(DataListener l)
l
- The listener to add.void removeDataListener(DataListener l)
l
- The listener to remove.boolean pivotGestureHappened(java.lang.Object source, int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, DataDirectorException
source
- The source of any events that this method fires. The DataView
passes this
as this parameter.fromEdge
- A constant that represents the edge to pivot from, such as COLUMN_EDGE
. Edge constants are listed in the See Also section.toEdge
- A constant that represents the edge to pivot to.fromLayer
- The layer to pivot from. The layer identifies the location of the dimension or dimension member on the edge. Zero is the outer-most layer on the edge.toLayer
- The layer to pivot to.flags
- A constant that represents the type of pivot to perform, such as PIVOT_SWAP
or PIVOT_MOVE_BEFORE
. The constants are listed in the See Also section, and they begin with PIVOT_.true
if the data director performs the pivot, false
if the pivot is not performed for some reason.EdgeOutOfRangeException
- If either edge parameter is too large.LayerOutOfRangeException
- If either layer parameter is negative or too large.DataDirectorException
- If a data provider error occurs.DataDirector.COLUMN_EDGE
, DataDirector.ROW_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.PIVOT_EDGES
, DataDirector.PIVOT_MOVE_AFTER
, DataDirector.PIVOT_MOVE_BEFORE
, *
viewPivotRequesting
event. If the event is not consumed, this method then calls the pivot
method in the data director, to pivot the data in the data source. After the call to the data director, this method fires a viewPivotRequested
event.
The view calls this method when a pivot gesture is detected in the UI.
boolean canPivot(java.lang.Object source, int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, DataDirectorException
source
- The source of any events that this method fires. The DataView
passes this
as this parameter.fromEdge
- A constant that represents the edge to pivot from, such as COLUMN_EDGE
. Edge constants are listed in the See Also section.toEdge
- A constant that represents the edge to pivot to.fromLayer
- The layer to pivot from. The layer identifies the location of the dimension or dimension member on the edge. Zero is the outer-most dimension on the edge.toLayer
- The layer to pivot to.flags
- A constant that represents the type of pivot to perform, such as PIVOT_SWAP
or PIVOT_MOVE_BEFORE
. The constants are listed in the See Also section, and they all begin with PIVOT_.true
if the pivot operation is legal, false
if not.EdgeOutOfRangeException
- If either edge parameter is too large.LayerOutOfRangeException
- If either layer parameter is negative or too large.DataDirectorException
- If a data provider error occurs.DataDirector.COLUMN_EDGE
, DataDirector.ROW_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.PIVOT_EDGES
, DataDirector.PIVOT_MOVE_AFTER
, DataDirector.PIVOT_MOVE_BEFORE
, DataDirector.PIVOT_SWAP
pivotOK
method in the data director, to pivot the data in the data source. The view calls this method when a pivot gesture is detected in the UI.boolean drillGestureHappened(java.lang.Object source, int edge, int layer, int slice, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
source
- The source of any events that this method fires. The DataView
passes this
as this parameter.edge
- A constant that represents the edge to drill, such as COLUMN_EDGE
. Edge constants are listed in the See Also secton.layer
- The layer to drill. The layer identifies the location of the dimension or dimension member on the edge. Zero is the outer-most layer on the edge.slice
- The slice to drill. The slice is zero-based. Each layer member in the innermost dimension has a unique slice. In outer layers, any slice that the outer layer spans can be used.flags
- A constant that represents the type of drill to perform, such as DRILLSTATE_DRILLABLE
to drill down in data. Drill constants are listed in the See Also section. They begin with DRILLSTATE_.true
if the data director performs the drill, false
if not.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.DataDirector.COLUMN_EDGE
, DataDirector.ROW_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.DRILLSTATE_DRILLABLE
, DataDirector.DRILLSTATE_IS_DRILLED
, DataDirector.DRILLSTATE_NOT_DRILLABLE
boolean canDrill(java.lang.Object source, int edge, int layer, int slice, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
source
- The source of any events that this method fires. The DataView
passes this
as this parameter.edge
- A constant that represents the edge to drill, such as COLUMN_EDGE
. Edge constants listed in the See Also section.layer
- The layer to drill. The layer identifies the location of the dimension or dimension member on the edge. Zero is the outer-most layer on the edge.slice
- The slice to drill. The slice is zero-based. Each layer member in the innermost layer has a unique slice. In outer layers, any slice that the outer layer spans can be used.flags
- A constant that represents the type of drill to perform, such as DRILLSTATE_DRILLABLE to drill down in data. Drill constants are listed in the See Also section. They begin with DRILLSTATE_.true
if the drill operation is legal, false
if not.EdgeOutOfRangeException
- If edge
is too large.DepthOutOfRangeException
- If depth
is negative or too large.SliceOutOfRangeException
- If slice
is negative or too large.DataDirectorException
- If a data provider error occurs.LayerOutOfRangeException
DataDirector.COLUMN_EDGE
, DataDirector.ROW_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.DRILLSTATE_DRILLABLE
, DataDirector.DRILLSTATE_IS_DRILLED
, DataDirector.DRILLSTATE_NOT_DRILLABLE
boolean pageChangeHappened(java.lang.Object source, int pos) throws SliceOutOfRangeException, DataDirectorException
source
- The source of any event that this method fires.pos
- A constant that represents the first page, last page, next page, or previous page. Constants are listed in the See Also section.true
if the page is changed, false
if not.SliceOutOfRangeException
- If page
is negative or too large.DataDirectorException
- If a data provider error occurs.VIEW_PAGE_FIRST
, VIEW_PAGE_LAST
, VIEW_PAGE_NEXT
, VIEW_PAGE_PREVIOUS
boolean pageChangeHappened(java.lang.Object source, int[] hPos, int maxLayerSpecified) throws LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
source
- The source of any event that this method fires.hPos
- An array of relative indices that indicate the set of new values to give to the various layers that make up the target slice.maxLayerSpecified
- The maximum index into hPos
(layer) that the call should use in making the slice change.true
if the page is changed, false
if not.LayerOutOfRangeException
- If there are too many layers.SliceOutOfRangeException
- If page
is negative or too large.DataDirectorException
- If a data provider error occurs.void setDataSource(DataSource ds)
ds
- The data source for this view.DataSource getDataSource()
null
if no data source has been specified for this view.void setDataDirector(DataDirector dd)
dd
- A DataDirector
implementation that has been initialized.DataDirector getDataDirector()
void setDataAccess(DataAccess dp)
dp
- An implementation of the DataAccess
interface.DataAccess getDataAccess()
DataAccess
for this view. This method can return null
if no data access has been specified for this view.void setDrillingEnabled(boolean b)
b
- true
to enable drilling, false
to disable drilling.boolean isDrillingEnabled()
true
if drilling is enabled, false
if not.void setErrorHandler(ErrorHandler eh)
eh
- The error handler for the view.Dataview.addErrorHandler(oracle.dss.util.ErrorHandler)
addErrorHandler
method of the view.ErrorHandler getErrorHandler()
null
if no error handler has been specified for the view.ControllerActions getControllerActions()
ControllerActions
object.ControllerActions
interface.void viewDataChanged(DataChangedEvent e)
e
- Information about the data change.
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |