org.pentaho.platform.plugin.action.mondrian.catalog
Class MondrianCatalogHelper

java.lang.Object
  org.pentaho.platform.plugin.action.mondrian.catalog.MondrianCatalogHelper

All Implemented Interfaces:

IMondrianCatalogService

public class MondrianCatalogHelper
extends Object
implements IMondrianCatalogService

Reads in file containing Mondrian data sources and catalogs. (Contains code copied from XmlaServlet.)

Author:

mlowery

Field Summary

static String

MONDRIAN_CATALOG_CACHE_REGION

Constructor Summary

MondrianCatalogHelper()

Method Summary

void	addCatalog(MondrianCatalog catalog, boolean overwrite, IPentahoSession pentahoSession) Adds to the global catalog list and possibly persists this information.
static int	addToCatalog(String baseUrl, boolean enableXmla, String schemaSolutionPath, IPentahoSession session, String jndiName, boolean overwrite)
MondrianCatalog	getCatalog(String context, IPentahoSession pentahoSession) Returns the catalog with the given context - name or definition allowable.
MondrianCatalogComplementInfo	getCatalogComplementInfoMap(String name) Method to access the MondrianCatalogComplementInfo taken a catalog name.
String	getDataSourcesConfig()
static MondrianCatalogHelper	getInstance() Deprecated. Please use PentahoSystem.get to get the Mondrian Catalog Service
boolean	isUseSchemaNameAsCatalogName()
List<MondrianCatalog>	listCatalogs(IPentahoSession pentahoSession, boolean jndiOnly) Lists all catalogs (filtered according to access control rules).
MondrianSchema	loadMondrianSchema(String solutionLocation, IPentahoSession pentahoSession) this method loads a mondrian schema
void	reInit(IPentahoSession pentahoSession)
void	setDataSourcesConfig(String dataSourcesConfig)
void	setUseSchemaNameAsCatalogName(boolean useSchemaNameAsCatalogName)

Methods inherited from class java.lang.Object

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

Field Detail

MONDRIAN_CATALOG_CACHE_REGION

public static String MONDRIAN_CATALOG_CACHE_REGION

Constructor Detail

MondrianCatalogHelper

public MondrianCatalogHelper()

Method Detail

getInstance

public static MondrianCatalogHelper getInstance()

Deprecated. Please use PentahoSystem.get to get the Mondrian Catalog Service

reInit

public void reInit(IPentahoSession pentahoSession)

getDataSourcesConfig

public String getDataSourcesConfig()

setDataSourcesConfig

public void setDataSourcesConfig(String dataSourcesConfig)

listCatalogs

public List<MondrianCatalog> listCatalogs(IPentahoSession pentahoSession,
                                          boolean jndiOnly)

Description copied from interface: IMondrianCatalogService

Lists all catalogs (filtered according to access control rules).

Specified by:

listCatalogs in interface IMondrianCatalogService

jndiOnly - return only JNDI-based catalogs

addCatalog

public void addCatalog(MondrianCatalog catalog,
                       boolean overwrite,
                       IPentahoSession pentahoSession)
                throws MondrianCatalogServiceException

Description copied from interface: IMondrianCatalogService

Adds to the global catalog list and possibly persists this information.

Specified by:

addCatalog in interface IMondrianCatalogService

overwrite - true to overwrite existing catalog (based on match with definition and effectiveDataSourceInfo

Throws:

MondrianCatalogServiceException

getCatalog

public MondrianCatalog getCatalog(String context,
                                  IPentahoSession pentahoSession)

Description copied from interface: IMondrianCatalogService

Returns the catalog with the given context - name or definition allowable. Returns null if context not recognized.

Specified by:

getCatalog in interface IMondrianCatalogService

Parameters:

context - Either the name of the catalog to fetch, or the catalog's definition string NOTE that the context can be the catalog name or the definition string for the catalog. If you are using the definition string to retrieve the catalog from the cache, you cannot be guaranteed what datasource is in play; so under these circumstances, this catalog's definition is the only part of the catalog that can be trusted. As this feature was added to enable looking up Mondrian roles from the schema, we don't much care which datasource is in play.

getCatalogComplementInfoMap

public MondrianCatalogComplementInfo getCatalogComplementInfoMap(String name)

Method to access the MondrianCatalogComplementInfo taken a catalog name.

Parameters:

name - Catalog schema location

Returns:

MondrianCatalogComplementInfo object

loadMondrianSchema

public MondrianSchema loadMondrianSchema(String solutionLocation,
                                         IPentahoSession pentahoSession)

this method loads a mondrian schema

Specified by:

loadMondrianSchema in interface IMondrianCatalogService

Parameters:

solutionLocation - location of the schema

pentahoSession - current session object

Returns:

Mondrian Schema object.

isUseSchemaNameAsCatalogName

public boolean isUseSchemaNameAsCatalogName()

setUseSchemaNameAsCatalogName

public void setUseSchemaNameAsCatalogName(boolean useSchemaNameAsCatalogName)

addToCatalog

public static int addToCatalog(String baseUrl,
                               boolean enableXmla,
                               String schemaSolutionPath,
                               IPentahoSession session,
                               String jndiName,
                               boolean overwrite)