com.tonbeller.jpivot.olap.model
Interface OlapModel

All Superinterfaces:
com.tonbeller.wcf.bookmarks.Bookmarkable, com.tonbeller.jpivot.core.Model
All Known Implementing Classes:
MondrianModel, OlapModelDecorator, OlapModelProxy

public interface OlapModel
extends com.tonbeller.jpivot.core.Model

Provides access to extensions, result and metadata. It does not specify what data are displayed (the query). Supports navigations thru Extensions.

See Also:
Extension, Result

Nested Class Summary
static class OlapModel.EmptyCubeException
          thrown if the result can not be computed because the cube is empty.
static class OlapModel.ResultTooLargeException
          thrown if too many result positions would be returned
 
Field Summary
 
Fields inherited from interface com.tonbeller.wcf.bookmarks.Bookmarkable
EXTENSIONAL, INTENSIONAL
 
Method Summary
 void destroy()
          called once when the not used any longer.
 com.tonbeller.jpivot.olap.model.Dimension[] getDimensions()
           
 java.lang.String getID()
           
 com.tonbeller.jpivot.olap.model.Member[] getMeasures()
           
 com.tonbeller.jpivot.olap.model.Result getResult()
          runs the query and returns the result
 void initialize()
          called once after creation.
 void initialize(java.util.List dimAccList)
          called once after creation.
 void setID(java.lang.String ID)
          sets an ID string for this model
 void setServletContext(javax.servlet.ServletContext servletContext)
          store a servlet context to the model
 
Methods inherited from interface com.tonbeller.jpivot.core.Model
addExtension, addModelChangeListener, getExtension, getExtensions, getTopDecorator, removeModelChangeListener, setLocale
 
Methods inherited from interface com.tonbeller.wcf.bookmarks.Bookmarkable
getBookmarkState, setBookmarkState
 

Method Detail

getResult

com.tonbeller.jpivot.olap.model.Result getResult()
                                                 throws com.tonbeller.jpivot.olap.model.OlapException
runs the query and returns the result

Throws:
com.tonbeller.jpivot.olap.model.OlapException

getDimensions

com.tonbeller.jpivot.olap.model.Dimension[] getDimensions()
Returns:
all dimensions of the cube for navigation

getMeasures

com.tonbeller.jpivot.olap.model.Member[] getMeasures()
Returns:
all measures of the cube for navigation

initialize

void initialize()
                throws com.tonbeller.jpivot.olap.model.OlapException
called once after creation. E.g. open DB connection

Throws:
com.tonbeller.jpivot.olap.model.OlapException

initialize

void initialize(java.util.List dimAccList)
                throws com.tonbeller.jpivot.olap.model.OlapException
called once after creation. E.g. open DB connection

Throws:
com.tonbeller.jpivot.olap.model.OlapException

destroy

void destroy()
called once when the not used any longer. E.g. close DB connection


getID

java.lang.String getID()
Returns:
an ID string for this model

setID

void setID(java.lang.String ID)
sets an ID string for this model


setServletContext

void setServletContext(javax.servlet.ServletContext servletContext)
store a servlet context to the model