com.eyeq.pivot4j.impl

Class PivotModelImpl

java.lang.Object

com.eyeq.pivot4j.impl.PivotModelImpl

All Implemented Interfaces:

PivotModel, Bookmarkable, Configurable

public class PivotModelImpl
extends Object
implements PivotModel

The pivot model represents all (meta-)data for an MDX query.

Constructor Summary

Constructors

Constructor and Description
PivotModelImpl(OlapDataSource dataSource)

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
protected void	closeConnection(OlapConnection connection)
protected OlapConnection	createConnection(OlapDataSource dataSource)
protected ExpressionContext	createExpressionContext()
protected QueryAdapter	createQueryAdapter()
void	destroy() Called once when the not used any longer.
protected CellSet	executeMdx(OlapConnection connection, String mdx)
protected void	fireModelChanged()
protected void	fireModelDestroyed()
protected void	fireModelInitialized()
protected void	fireQueryExecuted(Date start, long duration, String mdx)
protected void	fireStructureChanged()
Catalog	getCatalog()
CellSet	getCellSet() Runs the query and returns the result.
protected OlapConnection	getConnection() Returns the connection.
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.
protected String	getCurrentMdx(boolean evaluated)
OlapDataSource	getDataSource()
String	getEvaluatedMdx() Returns the current MDX query after all parameter expressions are resolved.
ExpressionContext	getExpressionContext()
ExpressionEvaluatorFactory	getExpressionEvaluatorFactory()
Locale	getLocale() Returns the current locale.
protected org.slf4j.Logger	getLogger()
String	getMdx() Returns the mdxQuery.
OlapDatabaseMetaData	getMetadata() Returns the database metadata for the active connection.
protected QueryAdapter	getQueryAdapter() Returns the queryAdapter.
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.
TransformFactory	getTransformFactory()
void	initialize()
boolean	isInitialized()
boolean	isSortable(Position position) returns true, if ONE of the members is a measure
boolean	isSorting()
boolean	isSorting(Position position) Return true if the result is sorted by the members of the position
protected boolean	isSortOnQuery()
protected String	normalizeMdx(String mdx)
protected void	onMdxChanged(String mdx)
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	restoreSettings(HierarchicalConfiguration configuration)
void	restoreState(Serializable state)
void	saveSettings(HierarchicalConfiguration configuration)
Serializable	saveState()
void	setExpressionEvaluatorFactory(ExpressionEvaluatorFactory factory)
void	setLocale(Locale locale) Sets the current locale.
void	setMdx(String mdxQuery) Sets the mdxQuery.
void	setRoleName(String roleName)
void	setSortCriteria(SortCriteria sortCriteria)
void	setSorting(boolean sorting)
void	setTopBottomCount(int topBottomCount)
void	setTransformFactory(TransformFactory factory)
void	sort(CellSetAxis axisToSort, Position position) Changes current sorting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PivotModelImpl

public PivotModelImpl(OlapDataSource dataSource)

Parameters:

dataSource -

Method Detail

getLogger

protected org.slf4j.Logger getLogger()

Returns:

the logger

getLocale

public Locale getLocale()

Returns the current locale.

Specified by:

getLocale in interface PivotModel

Returns:

Locale

See Also:

PivotModel.getLocale()

setLocale

public void setLocale(Locale locale)

Sets the current locale.

Specified by:

setLocale in interface PivotModel

Parameters:

locale - The locale to set

See Also:

PivotModel.setLocale(java.util.Locale)

getRoleName

public String getRoleName()

Specified by:

getRoleName in interface PivotModel

Returns:

the roleName

See Also:

PivotModel.getRoleName()

setRoleName

public void setRoleName(String roleName)

Specified by:

setRoleName in interface PivotModel

Parameters:

roleName - the roleName to set

See Also:

PivotModel.setRoleName(java.lang.String)

initialize

public void initialize()

Specified by:

initialize in interface PivotModel

See Also:

PivotModel.initialize()

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface PivotModel

See Also:

PivotModel.isInitialized()

createConnection

protected OlapConnection createConnection(OlapDataSource dataSource)
                                   throws SQLException

Parameters:

dataSource -

Returns:

Throws:

SQLException

destroy

public void destroy()

Description copied from interface: PivotModel

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

Specified by:

destroy in interface PivotModel

See Also:

PivotModel.destroy()

closeConnection

protected void closeConnection(OlapConnection connection)
                        throws SQLException

Parameters:

connection -

Throws:

SQLException

createExpressionContext

protected ExpressionContext createExpressionContext()

getConnection

protected OlapConnection getConnection()

Returns the connection.

getDataSource

public OlapDataSource getDataSource()

getCatalog

public Catalog getCatalog()

Returns:

Throws:

NotInitializedException

getMetadata

public OlapDatabaseMetaData getMetadata()

Description copied from interface: PivotModel

Returns the database metadata for the active connection.

Specified by:

getMetadata in interface PivotModel

See Also:

PivotModel.getMetadata()

getCube

public Cube getCube()

Description copied from interface: PivotModel

Returns the cube for the query.

Specified by:

getCube in interface PivotModel

See Also:

PivotModel.getCube()

getCellSet

public CellSet getCellSet()

Description copied from interface: PivotModel

Runs the query and returns the result.

Specified by:

getCellSet in interface PivotModel

See Also:

PivotModel.getCellSet()

refresh

public void refresh()

Description copied from interface: PivotModel

Flushes the last query result.

Specified by:

refresh in interface PivotModel

See Also:

PivotModel.refresh()

getExpressionContext

public ExpressionContext getExpressionContext()

Specified by:

getExpressionContext in interface PivotModel

See Also:

PivotModel.getExpressionContext()

executeMdx

protected CellSet executeMdx(OlapConnection connection,
                 String mdx)
                      throws OlapException

Parameters:

connection -

mdx -

Returns:

Throws:

OlapException

normalizeMdx

protected String normalizeMdx(String mdx)

getCurrentMdx

public String getCurrentMdx()

Description copied from interface: PivotModel

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

Specified by:

getCurrentMdx in interface PivotModel

See Also:

PivotModel.getCurrentMdx()

getEvaluatedMdx

public String getEvaluatedMdx()

Description copied from interface: PivotModel

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

Specified by:

getEvaluatedMdx in interface PivotModel

See Also:

PivotModel.getEvaluatedMdx()

getCurrentMdx

protected String getCurrentMdx(boolean evaluated)

Parameters:

evaluated -

Returns:

getMdx

public String getMdx()

Returns the mdxQuery.

Specified by:

getMdx in interface PivotModel

Returns:

String

setMdx

public void setMdx(String mdxQuery)

Sets the mdxQuery.

Specified by:

setMdx in interface PivotModel

Parameters:

mdxQuery - The mdxQuery to set

onMdxChanged

protected void onMdxChanged(String mdx)

Parameters:

mdx -

createQueryAdapter

protected QueryAdapter createQueryAdapter()

getQueryAdapter

protected QueryAdapter getQueryAdapter()

Returns the queryAdapter.

Returns:

QueryAdapter

getTransformFactory

public TransformFactory getTransformFactory()

Returns:

the transformFactory

setTransformFactory

public void setTransformFactory(TransformFactory factory)

Parameters:

factory - the transformFactory to set

getExpressionEvaluatorFactory

public ExpressionEvaluatorFactory getExpressionEvaluatorFactory()

Specified by:

getExpressionEvaluatorFactory in interface PivotModel

Returns:

the expressionEvaluatorFactory

See Also:

PivotModel.getExpressionEvaluatorFactory()

setExpressionEvaluatorFactory

public void setExpressionEvaluatorFactory(ExpressionEvaluatorFactory factory)

Parameters:

factory - the expressionEvaluatorFactory to set

addModelChangeListener

public void addModelChangeListener(ModelChangeListener listener)

Description copied from interface: PivotModel

Adds a model change listener

Specified by:

addModelChangeListener in interface PivotModel

See Also:

PivotModel.addModelChangeListener(com.eyeq.pivot4j.ModelChangeListener)

removeModelChangeListener

public void removeModelChangeListener(ModelChangeListener listener)

Description copied from interface: PivotModel

Removes a model change listener

Specified by:

removeModelChangeListener in interface PivotModel

See Also:

PivotModel.removeModelChangeListener(com.eyeq.pivot4j.ModelChangeListener)

fireModelInitialized

protected void fireModelInitialized()

fireModelChanged

protected void fireModelChanged()

fireStructureChanged

protected void fireStructureChanged()

fireModelDestroyed

protected void fireModelDestroyed()

addQueryListener

public void addQueryListener(QueryListener listener)

Description copied from interface: PivotModel

Adds a query listener

Specified by:

addQueryListener in interface PivotModel

See Also:

PivotModel.addQueryListener(com.eyeq.pivot4j.QueryListener)

removeQueryListener

public void removeQueryListener(QueryListener listener)

Description copied from interface: PivotModel

Removes a query listener

Specified by:

removeQueryListener in interface PivotModel

See Also:

PivotModel.removeQueryListener(com.eyeq.pivot4j.QueryListener)

fireQueryExecuted

protected void fireQueryExecuted(Date start,
                     long duration,
                     String mdx)

getTransform

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

Description copied from interface: PivotModel

Returns the registered transform instance for the given type.

Specified by:

getTransform in interface PivotModel

See Also:

PivotModel.getTransform(java.lang.Class)

isSorting

public boolean isSorting()

Specified by:

isSorting in interface PivotModel

See Also:

PivotModel.isSorting()

isSorting

public boolean isSorting(Position position)

Description copied from interface: PivotModel

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

Specified by:

isSorting in interface PivotModel

Parameters:

position - to be checked

Returns:

true, if position is the current sorting position

See Also:

PivotModel.isSorting(org.olap4j.Position)

setSorting

public void setSorting(boolean sorting)

Specified by:

setSorting in interface PivotModel

See Also:

PivotModel.setSorting(boolean)

getSortCriteria

public SortCriteria getSortCriteria()

Specified by:

getSortCriteria in interface PivotModel

Returns:

sort criteria (ASC,DESC,BASC,BDESC,TOPCOUNT,BOTTOMCOUNT)

setSortCriteria

public void setSortCriteria(SortCriteria sortCriteria)

Specified by:

setSortCriteria in interface PivotModel

See Also:

PivotModel.setSortCriteria(com.eyeq.pivot4j.sort.SortCriteria)

isSortable

public boolean isSortable(Position position)

returns true, if ONE of the members is a measure

Specified by:

isSortable in interface PivotModel

Parameters:

position - the position to check for sortability

Returns:

true, if the position is sortable

isSortOnQuery

protected boolean isSortOnQuery()

Returns:

true, if there is a sort for the query

getSortPosMembers

public List<Member> getSortPosMembers()

Specified by:

getSortPosMembers in interface PivotModel

See Also:

PivotModel.getSortPosMembers()

getTopBottomCount

public int getTopBottomCount()

Description copied from interface: PivotModel

Number of members for topcount and bottomcount

Specified by:

getTopBottomCount in interface PivotModel

Returns:

top/bottom count

See Also:

PivotModel.getTopBottomCount()

setTopBottomCount

public void setTopBottomCount(int topBottomCount)

Specified by:

setTopBottomCount in interface PivotModel

See Also:

PivotModel.setTopBottomCount(int)

sort

public void sort(CellSetAxis axisToSort,
        Position position)

Description copied from interface: PivotModel

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

Specified by:

sort in interface PivotModel

Parameters:

axisToSort - Axis containing the members to be sorted

position - Position on "other axis" defining the members by which the membersToSort are sorted

saveState

public Serializable saveState()

Specified by:

saveState in interface Bookmarkable

See Also:

Bookmarkable.saveState()

restoreState

public void restoreState(Serializable state)

Specified by:

restoreState in interface Bookmarkable

See Also:

Bookmarkable.restoreState(java.io.Serializable)

saveSettings

public void saveSettings(HierarchicalConfiguration configuration)

Specified by:

saveSettings in interface Configurable

See Also:

Configurable.saveSettings(org.apache.commons.configuration.HierarchicalConfiguration)

restoreSettings

public void restoreSettings(HierarchicalConfiguration configuration)

Specified by:

restoreSettings in interface Configurable

See Also:

Configurable.restoreSettings(org.apache.commons.configuration.HierarchicalConfiguration)