Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap
Interface OlapProvider

All Known Implementing Classes:
DefaultOlapProvider

public interface OlapProvider

OlapProvider is responsible for providing the olap data model with the pivoted information.


Method Summary
 void addOlapProviderListener(OlapProviderListener x)
          Adds a listener that is notified when the row, column header or filter area of an olap provider have changed.
 OlapColumnAdapter getColumnAdapter()
          Retrieves the column header model.
 Connection getConnection()
          Retrieves the underlying datasource connection
 OlapCube getCube()
          Retrieves the associated cube.
 Object getDataValueAt(TreePath[] rowPaths, TreePath[] columnPaths)
          Retrieves the data value at the specfied row and column paths.
 OlapMeasure getDefaultMeasure()
          Retrieves the default measure used, when the measure dimension does not appear in either the row or column headers.
 OlapRowAdapter getRowAdapter()
          Retrieves the row header model.
 TupleSelection getSlicingMembers()
          Retrieves a list of members that are used for slicing when querying the datasource.
 boolean isDataValueCached(TreePath[] rowPaths, TreePath[] columnPaths)
          Determines whether a data value has been retrieved from the underlying datasource.
 void removeOlapProviderListener(OlapProviderListener x)
          Removes a listener that is notified when the row, column header or filter area of an olap provider have changed.
 

Method Detail

addOlapProviderListener

void addOlapProviderListener(OlapProviderListener x)
Adds a listener that is notified when the row, column header or filter area of an olap provider have changed.

Parameters:
x - the listener to be added

getColumnAdapter

OlapColumnAdapter getColumnAdapter()
Retrieves the column header model.

Returns:
the column header

getConnection

Connection getConnection()
Retrieves the underlying datasource connection

Returns:
the underlying datasource connection

getCube

OlapCube getCube()
Retrieves the associated cube.

Returns:
the associated cube

getDefaultMeasure

OlapMeasure getDefaultMeasure()
Retrieves the default measure used, when the measure dimension does not appear in either the row or column headers.

Returns:
the displayed measure, in the absence of a measure dimension pivot

getRowAdapter

OlapRowAdapter getRowAdapter()
Retrieves the row header model.

Returns:
the row header

getSlicingMembers

TupleSelection getSlicingMembers()
Retrieves a list of members that are used for slicing when querying the datasource.

Returns:
a list of members used as the 'slice'

removeOlapProviderListener

void removeOlapProviderListener(OlapProviderListener x)
Removes a listener that is notified when the row, column header or filter area of an olap provider have changed.

Parameters:
x - the listener to be removed

getDataValueAt

Object getDataValueAt(TreePath[] rowPaths,
                      TreePath[] columnPaths)
Retrieves the data value at the specfied row and column paths.

Parameters:
rowPaths - the paths of the row header
columnPaths - the paths of the column header
Returns:
the value at the specified position

isDataValueCached

boolean isDataValueCached(TreePath[] rowPaths,
                          TreePath[] columnPaths)
Determines whether a data value has been retrieved from the underlying datasource.

Parameters:
rowPaths - the paths of the row header
columnPaths - the paths of the column header
Returns:
true, if the value has been cached, false otherwise

Copyright © 2011 Citra Technologies. All Rights Reserved.