org.pentaho.platform.plugin.services.metadata

Class PentahoMetadataDomainRepository

java.lang.Object

org.pentaho.platform.plugin.services.metadata.PentahoMetadataDomainRepository

All Implemented Interfaces:

org.pentaho.metadata.repository.IMetadataDomainRepository, IAclAwarePentahoMetadataDomainRepositoryImporter, IModelAnnotationsAwareMetadataDomainRepositoryImporter, IPentahoMetadataDomainRepositoryExporter, IPentahoMetadataDomainRepositoryImporter

Direct Known Subclasses:

CachingPentahoMetadataDomainRepository, PentahoMondrianDomainRepository, SecurityAwarePentahoMetadataDomainRepository

public class PentahoMetadataDomainRepository
extends Object
implements org.pentaho.metadata.repository.IMetadataDomainRepository, IModelAnnotationsAwareMetadataDomainRepositoryImporter, IAclAwarePentahoMetadataDomainRepositoryImporter, IPentahoMetadataDomainRepositoryExporter

Handles the storage and retrieval of Pentaho Metada Domain objects in a repository. It does this by using a pre-defined system location (defined by PentahoMetadataDomainRepositoryInfo) as the storage location for the Domain files and associated locale files.

Since Domain IDs are the unique identifier for Pentaho Metadata domains and may contain any character (including repository folder separator character(s) like '/', a UUID will be created to store each file. The metadata for the file will be used to store the information (such as the Domain ID).

Author:

David M. Kincade

Field Summary

Fields inherited from interface org.pentaho.metadata.repository.IMetadataDomainRepository

ACCESS_TYPE_ADMIN, ACCESS_TYPE_DELETE, ACCESS_TYPE_READ, ACCESS_TYPE_SCHEMA_ADMIN, ACCESS_TYPE_UPDATE, ACCESS_TYPE_WRITE

Fields inherited from interface org.pentaho.platform.plugin.services.metadata.IModelAnnotationsAwareMetadataDomainRepositoryImporter

ANNOTATIONS_FILE_ID_POSTFIX, PROPERTY_NAME_ANNOTATIONS

Constructor Summary

Constructors

Constructor and Description
PentahoMetadataDomainRepository(org.pentaho.platform.api.repository2.unified.IUnifiedRepository repository) Creates an instance of this class providing the IUnifiedRepository repository backend.

Method Summary

Modifier and Type	Method and Description
void	addLocalizationFile(String domainId, String locale, InputStream inputStream, boolean overwrite)
void	addLocalizationFile(String domainId, String locale, Properties properties) Adds a set of properties as a locale properties file for the specified Domain ID
void	createOrUpdateAnnotationsXml(org.pentaho.platform.api.repository2.unified.RepositoryFile domainFile, org.pentaho.platform.api.repository2.unified.RepositoryFile annotationsFile, String annotationsXml)
void	flushDomains() flush the domains from memory
String	generateRowLevelSecurityConstraint(org.pentaho.metadata.model.LogicalModel model)
org.pentaho.platform.api.repository2.unified.RepositoryFileAcl	getAclFor(String domainId)
org.pentaho.platform.api.repository2.unified.RepositoryFile	getAnnotationsXmlFile(org.pentaho.platform.api.repository2.unified.RepositoryFile domainFile)
org.pentaho.metadata.model.Domain	getDomain(String domainId) retrieve a domain from the repo.
Map<String,InputStream>	getDomainFilesData(String domainId)
Set<String>	getDomainIds() return a list of all the domain ids in the repository.
boolean	hasAccess(int accessType, org.pentaho.metadata.model.concept.IConcept aclHolder) The aclHolder cannot be null unless the access type requested is ACCESS_TYPE_SCHEMA_ADMIN.
boolean	hasAccessFor(String domainId)
String	loadAnnotationsXml(String domainId)
void	reloadDomains() reload domains from disk
void	removeDomain(String domainId) remove a domain from disk and memory.
void	removeModel(String domainId, String modelId) remove a model from a domain which is stored either on a disk or memory.
void	setAclFor(String domainId, org.pentaho.platform.api.repository2.unified.RepositoryFileAcl acl)
void	storeAnnotationsXml(String domainId, String annotationsXml)
void	storeDomain(org.pentaho.metadata.model.Domain domain, boolean overwrite) Store a domain to the repository.
void	storeDomain(InputStream inputStream, String domainId, boolean overwrite) Stores a domain to the repository directly as an Input Stream
void	storeDomain(InputStream inputStream, String domainId, boolean overwrite, org.pentaho.platform.api.repository2.unified.RepositoryFileAcl acl)

Methods inherited from class java.lang.Object

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

Constructor Detail

PentahoMetadataDomainRepository

public PentahoMetadataDomainRepository(org.pentaho.platform.api.repository2.unified.IUnifiedRepository repository)

Creates an instance of this class providing the IUnifiedRepository repository backend.

Parameters:

repository - the IUnifiedRepository in which data will be stored / retrieved

Method Detail

storeDomain

public void storeDomain(org.pentaho.metadata.model.Domain domain,
                        boolean overwrite)
                 throws org.pentaho.metadata.repository.DomainIdNullException,
                        org.pentaho.metadata.repository.DomainAlreadyExistsException,
                        org.pentaho.metadata.repository.DomainStorageException

Store a domain to the repository. The domain should persist between JVM restarts.

Specified by:

storeDomain in interface org.pentaho.metadata.repository.IMetadataDomainRepository

Parameters:

domain - domain object to store

overwrite - if true, overwrite existing domain

Throws:

org.pentaho.metadata.repository.DomainIdNullException - if domain id is null or empty

org.pentaho.metadata.repository.DomainAlreadyExistsException - if a domain with the same Domain ID already exists in the repository and overwrite == false

org.pentaho.metadata.repository.DomainStorageException - if there is a problem storing the domain

storeDomain

public void storeDomain(InputStream inputStream,
                        String domainId,
                        boolean overwrite)
                 throws org.pentaho.metadata.repository.DomainIdNullException,
                        org.pentaho.metadata.repository.DomainAlreadyExistsException,
                        org.pentaho.metadata.repository.DomainStorageException

Stores a domain to the repository directly as an Input Stream

Specified by:

storeDomain in interface IPentahoMetadataDomainRepositoryImporter

Parameters:

inputStream -

domainId -

overwrite -

Throws:

org.pentaho.metadata.repository.DomainIdNullException

org.pentaho.metadata.repository.DomainAlreadyExistsException

org.pentaho.metadata.repository.DomainStorageException

storeDomain

public void storeDomain(InputStream inputStream,
                        String domainId,
                        boolean overwrite,
                        org.pentaho.platform.api.repository2.unified.RepositoryFileAcl acl)
                 throws org.pentaho.metadata.repository.DomainIdNullException,
                        org.pentaho.metadata.repository.DomainAlreadyExistsException,
                        org.pentaho.metadata.repository.DomainStorageException

Specified by:

storeDomain in interface IAclAwarePentahoMetadataDomainRepositoryImporter

Throws:

org.pentaho.metadata.repository.DomainIdNullException

org.pentaho.metadata.repository.DomainAlreadyExistsException

org.pentaho.metadata.repository.DomainStorageException

setAclFor

public void setAclFor(String domainId,
                      org.pentaho.platform.api.repository2.unified.RepositoryFileAcl acl)

Specified by:

setAclFor in interface IAclAwarePentahoMetadataDomainRepositoryImporter

getAclFor

public org.pentaho.platform.api.repository2.unified.RepositoryFileAcl getAclFor(String domainId)

Specified by:

getAclFor in interface IAclAwarePentahoMetadataDomainRepositoryImporter

hasAccessFor

public boolean hasAccessFor(String domainId)

Specified by:

hasAccessFor in interface IAclAwarePentahoMetadataDomainRepositoryImporter

getDomainFilesData

public Map<String,InputStream> getDomainFilesData(String domainId)

Specified by:

getDomainFilesData in interface IPentahoMetadataDomainRepositoryExporter

getDomain

public org.pentaho.metadata.model.Domain getDomain(String domainId)

retrieve a domain from the repo. This does lazy loading of the repo, so it calls reloadDomains() if not already loaded.

Specified by:

getDomain in interface org.pentaho.metadata.repository.IMetadataDomainRepository

Parameters:

domainId - domain to get from the repository

Returns:

domain object

getDomainIds

public Set<String> getDomainIds()

return a list of all the domain ids in the repository. triggers a call to reloadDomains if necessary.

Specified by:

getDomainIds in interface org.pentaho.metadata.repository.IMetadataDomainRepository

Returns:

the domain Ids.

removeDomain

public void removeDomain(String domainId)

remove a domain from disk and memory.

Specified by:

removeDomain in interface org.pentaho.metadata.repository.IMetadataDomainRepository

Specified by:

removeDomain in interface IPentahoMetadataDomainRepositoryImporter

Parameters:

domainId -

removeModel

public void removeModel(String domainId,
                        String modelId)
                 throws org.pentaho.metadata.repository.DomainIdNullException,
                        org.pentaho.metadata.repository.DomainStorageException

remove a model from a domain which is stored either on a disk or memory.

Specified by:

removeModel in interface org.pentaho.metadata.repository.IMetadataDomainRepository

Parameters:

domainId -

modelId -

Throws:

org.pentaho.metadata.repository.DomainIdNullException

org.pentaho.metadata.repository.DomainStorageException

reloadDomains

public void reloadDomains()

reload domains from disk

Specified by:

reloadDomains in interface org.pentaho.metadata.repository.IMetadataDomainRepository

flushDomains

public void flushDomains()

flush the domains from memory

Specified by:

flushDomains in interface org.pentaho.metadata.repository.IMetadataDomainRepository

generateRowLevelSecurityConstraint

public String generateRowLevelSecurityConstraint(org.pentaho.metadata.model.LogicalModel model)

Specified by:

generateRowLevelSecurityConstraint in interface org.pentaho.metadata.repository.IMetadataDomainRepository

hasAccess

public boolean hasAccess(int accessType,
                         org.pentaho.metadata.model.concept.IConcept aclHolder)

The aclHolder cannot be null unless the access type requested is ACCESS_TYPE_SCHEMA_ADMIN.

Specified by:

hasAccess in interface org.pentaho.metadata.repository.IMetadataDomainRepository

addLocalizationFile

public void addLocalizationFile(String domainId,
                                String locale,
                                Properties properties)
                         throws org.pentaho.metadata.repository.DomainStorageException

Adds a set of properties as a locale properties file for the specified Domain ID

Parameters:

domainId - the domain ID for which this properties file will be added

locale - the locale for which this properties file will be added

properties - the properties to be added

Throws:

org.pentaho.metadata.repository.DomainStorageException

addLocalizationFile

public void addLocalizationFile(String domainId,
                                String locale,
                                InputStream inputStream,
                                boolean overwrite)
                         throws org.pentaho.metadata.repository.DomainStorageException

Specified by:

addLocalizationFile in interface IPentahoMetadataDomainRepositoryImporter

Throws:

org.pentaho.metadata.repository.DomainStorageException

loadAnnotationsXml

public String loadAnnotationsXml(String domainId)

Specified by:

loadAnnotationsXml in interface IModelAnnotationsAwareMetadataDomainRepositoryImporter

storeAnnotationsXml

public void storeAnnotationsXml(String domainId,
                                String annotationsXml)

Specified by:

storeAnnotationsXml in interface IModelAnnotationsAwareMetadataDomainRepositoryImporter

getAnnotationsXmlFile

public org.pentaho.platform.api.repository2.unified.RepositoryFile getAnnotationsXmlFile(org.pentaho.platform.api.repository2.unified.RepositoryFile domainFile)

createOrUpdateAnnotationsXml

public void createOrUpdateAnnotationsXml(org.pentaho.platform.api.repository2.unified.RepositoryFile domainFile,
                                         org.pentaho.platform.api.repository2.unified.RepositoryFile annotationsFile,
                                         String annotationsXml)