org.pentaho.platform.api.repository2.unified

Interface IPlatformImportBundle

public interface IPlatformImportBundle

A struct-like object for bundling related objects together for import into the platform. Bundles contain all information necessary for import into the system. While this interface includes a hash-map optional parameters function, it should be subclassed if many properties are accessed this way.

Author:

mlowery, nbaker, tband

Method Summary

Modifier and Type	Method and Description
RepositoryFileAcl	getAcl() Ability to use the export manifest during import to apply ACL and File settings
String	getCharSet() Optional character set for the binary InputStream.
List<IPlatformImportBundle>	getChildBundles() This allows for arbitrary parent-child trees to be imported.
RepositoryFileExtraMetaData	getExtraMetaData() Ability to use the export manifest during import to apply extraMetaData
InputStream	getInputStream() Optional InputStream for content with a binary component.
String	getMimeType() mime-type to be used to resolve an IPlatformImportHandler.
String	getName() Optional content name.
String	getPath() Path which may be used to indicate where a bundle belongs in the repository.
Object	getProperty(String prop) Convenience method for extra properties.
boolean	isApplyAclSettings()
boolean	isOverwriteAclSettings()
boolean	isPreserveDsw() Preserve DSW OLAP model data
boolean	isRetainOwnership()
boolean	overwriteInRepository() pass in flag to allow overwrite in repository (if exists)
void	setAcl(RepositoryFileAcl acl)
void	setApplyAclSettings(boolean applyAclSettings) use the import manfiest file to apply ACL settings to files and folders
void	setExtraMetaData(RepositoryFileExtraMetaData extraMetaData) use the import manifest file to apply extraMetaData
void	setOverwriteAclSettings(boolean overwriteAclSettings) use the import manifest ACL settings and overwrite existing settings
void	setPath(String path) Path which may be used to indicate where a bundle belongs in the repository.
void	setPreserveDsw(boolean preserveDsw) Preserve DSW OLAP model data
void	setRetainOwnership(boolean retainOwnership) retain the file metadata ownership

Method Detail

getChildBundles

List<IPlatformImportBundle> getChildBundles()

This allows for arbitrary parent-child trees to be imported. Note this does not support the folder/file paradigm and is instead a logical relationship between import bundles.

Returns:

a list of "child" bundles.

getName

String getName()

Optional content name. Repository content this will be stored based on this name

Returns:

optional name

setPath

void setPath(String path)

Path which may be used to indicate where a bundle belongs in the repository.

Parameters:

path -

getPath

String getPath()

Path which may be used to indicate where a bundle belongs in the repository.

Returns:

path

getInputStream

InputStream getInputStream()
                    throws IOException

Optional InputStream for content with a binary component.

Returns:

optional InputStream

Throws:

IOException

getCharSet

String getCharSet()

Optional character set for the binary InputStream. UTF-8 will be used by default for in the case of binary text content

Returns:

Optional character set for the associated InputStream

getMimeType

String getMimeType()

mime-type to be used to resolve an IPlatformImportHandler. If not set the IPlatformImporter will attempt to resolve a mime-type based on the configured IPlatformMimeResolver

Returns:

mime-type

getProperty

Object getProperty(String prop)

Convenience method for extra properties. A subclass would be preferred if there are a great number of properties accessed from this method.

Parameters:

prop -

Returns:

property Object

overwriteInRepository

boolean overwriteInRepository()

pass in flag to allow overwrite in repository (if exists)

Returns:

boolean

getAcl

RepositoryFileAcl getAcl()

Ability to use the export manifest during import to apply ACL and File settings

Returns:

setAcl

void setAcl(RepositoryFileAcl acl)

isOverwriteAclSettings

boolean isOverwriteAclSettings()

setOverwriteAclSettings

void setOverwriteAclSettings(boolean overwriteAclSettings)

use the import manifest ACL settings and overwrite existing settings

Parameters:

overwriteAclSettings -

getExtraMetaData

RepositoryFileExtraMetaData getExtraMetaData()

Ability to use the export manifest during import to apply extraMetaData

Returns:

setExtraMetaData

void setExtraMetaData(RepositoryFileExtraMetaData extraMetaData)

use the import manifest file to apply extraMetaData

Parameters:

extraMetaData -

isRetainOwnership

boolean isRetainOwnership()

setRetainOwnership

void setRetainOwnership(boolean retainOwnership)

retain the file metadata ownership

Parameters:

retainOwnership -

isApplyAclSettings

boolean isApplyAclSettings()

setApplyAclSettings

void setApplyAclSettings(boolean applyAclSettings)

use the import manfiest file to apply ACL settings to files and folders

Parameters:

applyAclSettings -

isPreserveDsw

boolean isPreserveDsw()

Preserve DSW OLAP model data

Returns:

setPreserveDsw

void setPreserveDsw(boolean preserveDsw)

Preserve DSW OLAP model data

Parameters:

preserveDsw -