Interface IMondrianCatalogService
-
- All Known Subinterfaces:
IAclAwareMondrianCatalogService
- All Known Implementing Classes:
MondrianCatalogHelper
public interface IMondrianCatalogService
A service registering/enumerating registered Mondrian catalogs (schemas).- Author:
- mlowery
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addCatalog(InputStream inputStream, MondrianCatalog catalog, boolean overwriteInRepossitory, org.pentaho.platform.api.engine.IPentahoSession session)
pass the input stream directly from data access PUC and schema workbenchvoid
addCatalog(MondrianCatalog catalog, boolean overwrite, org.pentaho.platform.api.engine.IPentahoSession pentahoSession)
Adds to the global catalog list and possibly persists this information.MondrianCatalog
getCatalog(String context, org.pentaho.platform.api.engine.IPentahoSession pentahoSession)
Returns the catalog with the given context - name or definition allowable.List<MondrianCatalog>
listCatalogs(org.pentaho.platform.api.engine.IPentahoSession pentahoSession, boolean jndiOnly)
Lists all catalogs (filtered according to access control rules).MondrianSchema
loadMondrianSchema(String solutionLocation, org.pentaho.platform.api.engine.IPentahoSession pentahoSession)
this method loads a Mondrian schemavoid
reInit(org.pentaho.platform.api.engine.IPentahoSession pentahoSession)
Flushes the catalog cache.void
removeCatalog(String catalogName, org.pentaho.platform.api.engine.IPentahoSession pentahoSession)
this method removes a Mondrian schema from the platform
-
-
-
Method Detail
-
listCatalogs
List<MondrianCatalog> listCatalogs(org.pentaho.platform.api.engine.IPentahoSession pentahoSession, boolean jndiOnly)
Lists all catalogs (filtered according to access control rules).- Parameters:
jndiOnly
- return only JNDI-based catalogs
-
addCatalog
void addCatalog(MondrianCatalog catalog, boolean overwrite, org.pentaho.platform.api.engine.IPentahoSession pentahoSession) throws MondrianCatalogServiceException
Adds to the global catalog list and possibly persists this information.- Parameters:
overwrite
- true to overwrite existing catalog (based on match with definition and effectiveDataSourceInfo- Throws:
MondrianCatalogServiceException
-
getCatalog
MondrianCatalog getCatalog(String context, org.pentaho.platform.api.engine.IPentahoSession pentahoSession)
Returns the catalog with the given context - name or definition allowable. Returnsnull
if context not recognized.- 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.
-
loadMondrianSchema
MondrianSchema loadMondrianSchema(String solutionLocation, org.pentaho.platform.api.engine.IPentahoSession pentahoSession)
this method loads a Mondrian schema- Parameters:
solutionLocation
- location of the schemapentahoSession
- current session object- Returns:
- Mondrian Schema object
-
removeCatalog
void removeCatalog(String catalogName, org.pentaho.platform.api.engine.IPentahoSession pentahoSession)
this method removes a Mondrian schema from the platform- Parameters:
catalogName
- the name of the catalog to removepentahoSession
- current session object
-
reInit
void reInit(org.pentaho.platform.api.engine.IPentahoSession pentahoSession) throws MondrianCatalogServiceException
Flushes the catalog cache.- Parameters:
pentahoSession
-- Throws:
MondrianCatalogServiceException
-
addCatalog
void addCatalog(InputStream inputStream, MondrianCatalog catalog, boolean overwriteInRepossitory, org.pentaho.platform.api.engine.IPentahoSession session)
pass the input stream directly from data access PUC and schema workbench- Parameters:
inputStream
-catalog
-overwriteInRepossitory
-session
-
-
-