org.pentaho.platform.api.repository

Interface IRepositoryFile

All Superinterfaces:

IAclHolder, IAclSolutionFile, ISearchable, ISolutionFile

public interface IRepositoryFile
extends ISearchable, IAclSolutionFile

Field Summary

Fields

Modifier and Type	Field and Description
static char	SEPARATOR

Fields inherited from interface org.pentaho.platform.api.repository.ISearchable

SEARCH_TYPE_PHRASE, SEARCH_TYPE_WORDS_AND, SEARCH_TYPE_WORDS_OR

Fields inherited from interface org.pentaho.platform.api.engine.IAclHolder

ACCESS_TYPE_ADMIN, ACCESS_TYPE_DELETE, ACCESS_TYPE_READ, ACCESS_TYPE_UPDATE, ACCESS_TYPE_WRITE

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildFile(IRepositoryFile file)
int	compareTo(Object o)
boolean	containsActions()
boolean	exists()
Set	getChildrenFiles() Gets the set children IAclSolutionFiles from this IAclSolutionFile.
byte[]	getData()
String	getExtension()
String	getFileId()
String	getFileName()
String	getFullPath()
long	getLastModified()
IRepositoryFile	getParent()
String	getPhraseSearchQueryName()
int	getRevision()
String[]	getSearchableColumns()
String	getSearchableTable()
String	getSolution()
String	getSolutionPath()
boolean	hasExtension()
boolean	isDirectory()
boolean	isRoot()
ISolutionFile[]	listFiles() If this is a directory, will list all children files/directories for hierarchical navigation.
ISolutionFile[]	listFiles(IFileFilter filter)
IRepositoryFile[]	listRepositoryFiles()
void	removeChildFile(IRepositoryFile file)
void	resetAccessControls(List acls) Replaces existing access controls with a new list of access controls.
ISolutionFile	retrieveParent() NOTE: This method is named 'retrieveParent' instead of 'getParent' because the generic ISolutionFile type is not a 'Hibernate' described type and one of the base classes (RepositoryFile) will fail dependency checking.
void	setAccessControls(List acls) This method's purpose is to allow Hibernate to initialize the ACLs from the data-store.
void	setChildrenFiles(Set childrenFiles)
void	setData(byte[] data)
void	setLastModified(long modDate)
void	setParent(IRepositoryFile parent)

Methods inherited from interface org.pentaho.platform.api.engine.IAclHolder

getAccessControls, getEffectiveAccessControls

Field Detail

SEPARATOR

static final char SEPARATOR

See Also:

Constant Field Values

Method Detail

setAccessControls

void setAccessControls(List acls)

This method's purpose is to allow Hibernate to initialize the ACLs from the data-store. Application clients should likely use resetAccessControls.

Specified by:

setAccessControls in interface IAclHolder

resetAccessControls

void resetAccessControls(List acls)

Description copied from interface: IAclHolder

Replaces existing access controls with a new list of access controls. This method should be used in favor of setting the access controls with setAccessControls when the object is being persisted.

Specified by:

resetAccessControls in interface IAclHolder

getRevision

int getRevision()

getFileId

String getFileId()

getSolution

String getSolution()

Specified by:

getSolution in interface ISolutionFile

Returns:

Name of the solution this file/directory is contained within

getSolutionPath

String getSolutionPath()

Specified by:

getSolutionPath in interface ISolutionFile

Returns:

path within the solution to the file/directory.

getFileName

String getFileName()

Specified by:

getFileName in interface ISolutionFile

Returns:

The name of the file/directory

getFullPath

String getFullPath()

Specified by:

getFullPath in interface ISolutionFile

Returns:

fully qualified path to this file/directory

setParent

void setParent(IRepositoryFile parent)

getParent

IRepositoryFile getParent()

retrieveParent

ISolutionFile retrieveParent()

Description copied from interface: ISolutionFile

NOTE: This method is named 'retrieveParent' instead of 'getParent' because the generic ISolutionFile type is not a 'Hibernate' described type and one of the base classes (RepositoryFile) will fail dependency checking.

Specified by:

retrieveParent in interface ISolutionFile

Returns:

The parent file for this ISolutionFile

getSearchableColumns

String[] getSearchableColumns()

Specified by:

getSearchableColumns in interface ISearchable

Returns:

Returns an array of the char/varchar columns that can be searched.

getSearchableTable

String getSearchableTable()

Specified by:

getSearchableTable in interface ISearchable

Returns:

Returns the name of the hibernated object which will be used in the search.

getPhraseSearchQueryName

String getPhraseSearchQueryName()

Specified by:

getPhraseSearchQueryName in interface ISearchable

Returns:

Returns the fully-package-qualified name of a named query in the Hibernate Schema that supports a full-text search of all searchable columns. The parameter name for the search term in the query must be :searchTerm or the query will fail.

isDirectory

boolean isDirectory()

Specified by:

isDirectory in interface ISolutionFile

Returns:

true if the ISolutionFile points to a directory.

getChildrenFiles

Set getChildrenFiles()

Description copied from interface: IAclSolutionFile

Gets the set children IAclSolutionFiles from this IAclSolutionFile. Each child must be an instance of IAclSolutionFile.

Specified by:

getChildrenFiles in interface IAclSolutionFile

Returns:

Returns the childrenResources.

setChildrenFiles

void setChildrenFiles(Set childrenFiles)

Parameters:

childrenResources - The childrenResources to set.

addChildFile

void addChildFile(IRepositoryFile file)

removeChildFile

void removeChildFile(IRepositoryFile file)

getData

byte[] getData()

Specified by:

getData in interface ISolutionFile

Returns:

Returns the data.

setData

void setData(byte[] data)

Parameters:

data - The data to set.

listFiles

ISolutionFile[] listFiles(IFileFilter filter)

Specified by:

listFiles in interface ISolutionFile

listFiles

ISolutionFile[] listFiles()

Description copied from interface: ISolutionFile

If this is a directory, will list all children files/directories for hierarchical navigation.

Specified by:

listFiles in interface ISolutionFile

listRepositoryFiles

IRepositoryFile[] listRepositoryFiles()

compareTo

int compareTo(Object o)

getLastModified

long getLastModified()

Specified by:

getLastModified in interface ISolutionFile

Returns:

Returns the modDate.

setLastModified

void setLastModified(long modDate)

Parameters:

modDate - The modDate to set.

containsActions

boolean containsActions()

isRoot

boolean isRoot()

Specified by:

isRoot in interface ISolutionFile

Returns:

true if this is the root solution folder NOTE: This will always return false for a filebased solution

hasExtension

boolean hasExtension()

Returns:

a boolean indicating if this file has an extension

getExtension

String getExtension()

Specified by:

getExtension in interface ISolutionFile

Returns:

the extension (including the . seperator) of this file

exists

boolean exists()

Specified by:

exists in interface ISolutionFile