org.pentaho.platform.api.engine
Interface ISolutionFile

All Known Subinterfaces:

IAclSolutionFile, IRepositoryFile

All Known Implementing Classes:

FileSolutionFile, RepositoryFile

public interface ISolutionFile

A solution file is an abstract represention of either a file or a directory. This allows us to treat files and directories as the same thing for the purposes of hierarchical navigation

Author:

jdixon

Method Summary

boolean	exists()
byte[]	getData()
String	getExtension()
String	getFileName()
String	getFullPath()
long	getLastModified()
String	getSolution()
String	getSolutionPath()
boolean	isDirectory()
boolean	isRoot()
ISolutionFile[]	listFiles() If this is a directory, will list all children files/directories for hierarchical navigation.
ISolutionFile[]	listFiles(IFileFilter filter)
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.

Method Detail

isDirectory

boolean isDirectory()

Returns:

true if the ISolutionFile points to a directory.

getFileName

String getFileName()

Returns:

The name of the file/directory

getSolutionPath

String getSolutionPath()

Returns:

path within the solution to the file/directory.

getSolution

String getSolution()

Returns:

Name of the solution this file/directory is contained within

getFullPath

String getFullPath()

Returns:

fully qualified path to this file/directory

listFiles

ISolutionFile[] listFiles()

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

listFiles

ISolutionFile[] listFiles(IFileFilter filter)

isRoot

boolean isRoot()

Returns:

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

retrieveParent

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.

Returns:

The parent file for this ISolutionFile

getData

byte[] getData()

exists

boolean exists()

getLastModified

long getLastModified()

Returns:

Returns the modDate.

getExtension

String getExtension()