com.eyeq.pivot4j

Interface PivotModel

All Superinterfaces:

Bookmarkable, Configurable

All Known Implementing Classes:

PivotModelImpl

public interface PivotModel
extends Configurable, Bookmarkable

Provides access to result and metadata. It does not specify what data are displayed (the query).

Method Summary

Methods

Modifier and Type	Method and Description
void	addModelChangeListener(ModelChangeListener listener) Adds a model change listener
void	addQueryListener(QueryListener listener) Adds a query listener
void	destroy() Called once when the not used any longer.
CellSet	getCellSet() Runs the query and returns the result.
Cube	getCube() Returns the cube for the query.
String	getCurrentMdx() Returns the current MDX query which this model instance is based on or null if the model is not initialized.
String	getEvaluatedMdx() Returns the current MDX query after all parameter expressions are resolved.
ExpressionContext	getExpressionContext()
ExpressionEvaluatorFactory	getExpressionEvaluatorFactory()
Locale	getLocale()
String	getMdx() The initial MDX query.
OlapDatabaseMetaData	getMetadata() Returns the database metadata for the active connection.
String	getRoleName()
SortCriteria	getSortCriteria()
List<Member>	getSortPosMembers()
int	getTopBottomCount() Number of members for topcount and bottomcount
<T extends Transform> T	getTransform(Class<T> type) Returns the registered transform instance for the given type.
void	initialize()
boolean	isInitialized()
boolean	isSortable(Position position) Returns true if user may sort by the members.
boolean	isSorting()
boolean	isSorting(Position position) Return true if the result is sorted by the members of the position
void	refresh() Flushes the last query result.
void	removeModelChangeListener(ModelChangeListener listener) Removes a model change listener
void	removeQueryListener(QueryListener listener) Removes a query listener
void	setLocale(Locale locale) Sets the locale for messages, data display etc
void	setMdx(String mdxQuery)
void	setRoleName(String roleName)
void	setSortCriteria(SortCriteria criteria)
void	setSorting(boolean enabled)
void	setTopBottomCount(int topBottomCount)
void	sort(CellSetAxis axisToSort, Position position) Changes current sorting.

Methods inherited from interface com.eyeq.pivot4j.state.Configurable

restoreSettings, saveSettings

Methods inherited from interface com.eyeq.pivot4j.state.Bookmarkable

restoreState, saveState

Method Detail

initialize

void initialize()

isInitialized

boolean isInitialized()

destroy

void destroy()

Called once when the not used any longer. E.g. close DB connection

Throws:

NotInitializedException

getMetadata

OlapDatabaseMetaData getMetadata()

Returns the database metadata for the active connection.

getCube

Cube getCube()

Returns the cube for the query.

Throws:

NotInitializedException

getCellSet

CellSet getCellSet()

Runs the query and returns the result.

Throws:

NotInitializedException

refresh

void refresh()

Flushes the last query result.

Throws:

NotInitializedException

getMdx

String getMdx()

The initial MDX query. This is never changed except when the user enters a new MDX query.

setMdx

void setMdx(String mdxQuery)

getCurrentMdx

String getCurrentMdx()

Returns the current MDX query which this model instance is based on or null if the model is not initialized.

getEvaluatedMdx

String getEvaluatedMdx()

Returns the current MDX query after all parameter expressions are resolved. The result would be identical with getCurrentMdx() if no parameter expressions are present.

getLocale

Locale getLocale()

setLocale

void setLocale(Locale locale)

Sets the locale for messages, data display etc

getRoleName

String getRoleName()

setRoleName

void setRoleName(String roleName)

getExpressionContext

ExpressionContext getExpressionContext()

addModelChangeListener

void addModelChangeListener(ModelChangeListener listener)

Adds a model change listener

removeModelChangeListener

void removeModelChangeListener(ModelChangeListener listener)

Removes a model change listener

addQueryListener

void addQueryListener(QueryListener listener)

Adds a query listener

removeQueryListener

void removeQueryListener(QueryListener listener)

Removes a query listener

getTransform

<T extends Transform> T getTransform(Class<T> type)

Returns the registered transform instance for the given type.

getExpressionEvaluatorFactory

ExpressionEvaluatorFactory getExpressionEvaluatorFactory()

sort

void sort(CellSetAxis axisToSort,
        Position position)

Changes current sorting. If mode is TOPCOUNT or BOTTOMCOUNT the current value of topBottomCount will be used.

Parameters:

axisToSort - the axis to sort. Its ONE of the "other" axes, that do not contain position

position - the sort criteria

Throws:

NotInitializedException

isSorting

boolean isSorting()

isSorting

boolean isSorting(Position position)

Return true if the result is sorted by the members of the position

setSorting

void setSorting(boolean enabled)

isSortable

boolean isSortable(Position position)

Returns true if user may sort by the members. This will be the case when ONE of the members is a measure. The GUI will paint a "sort button" for ONE of the members

getSortCriteria

SortCriteria getSortCriteria()

setSortCriteria

void setSortCriteria(SortCriteria criteria)

getSortPosMembers

List<Member> getSortPosMembers()

getTopBottomCount

int getTopBottomCount()

Number of members for topcount and bottomcount

setTopBottomCount

void setTopBottomCount(int topBottomCount)