Package org.pentaho.di.core.vfs

Interface IKettleVFS

All Known Implementing Classes:

KettleVFSImpl

public interface IKettleVFS

An interface to a bowl-specific KettleVFS interface. Most, but not all methods from KettleVFS have been moved to this interface. Methods that remain are truly static or use state that must remain global. Use KettleVFS.getInstance( Bowl ) to get an instance.

Method Summary

Modifier and Type	Method	Description
org.apache.commons.vfs2.FileObject	createTempFile(String prefix, String suffix, String directory)
org.apache.commons.vfs2.FileObject	createTempFile(String prefix, String suffix, String directory, VariableSpace space)
org.apache.commons.vfs2.FileObject	createTempFile(String prefix, KettleVFS.Suffix suffix)	Creates a file using "java.io.tmpdir" directory
org.apache.commons.vfs2.FileObject	createTempFile(String prefix, KettleVFS.Suffix suffix, String directory)
org.apache.commons.vfs2.FileObject	createTempFile(String prefix, KettleVFS.Suffix suffix, String directory, VariableSpace space)
org.apache.commons.vfs2.FileObject	createTempFile(String prefix, KettleVFS.Suffix suffix, VariableSpace variableSpace)	Creates a file using "java.io.tmpdir" directory
boolean	fileExists(String vfsFilename)
boolean	fileExists(String vfsFilename, VariableSpace space)
org.apache.commons.vfs2.FileObject	getFileObject(String vfsFilename)
org.apache.commons.vfs2.FileObject	getFileObject(String vfsFilename, org.apache.commons.vfs2.FileSystemOptions fsOptions)
org.apache.commons.vfs2.FileObject	getFileObject(String vfsFilename, VariableSpace space)
org.apache.commons.vfs2.FileObject	getFileObject(String vfsFilename, VariableSpace space, org.apache.commons.vfs2.FileSystemOptions fsOptions)
org.apache.commons.vfs2.FileSystemOptions	getFileSystemOptions(String scheme, String vfsFilename, VariableSpace space, org.apache.commons.vfs2.FileSystemOptions fileSystemOptions)
String	getFriendlyURI(String filename)
String	getFriendlyURI(String filename, VariableSpace space)
InputStream	getInputStream(String vfsFilename)
InputStream	getInputStream(String vfsFilename, VariableSpace space)
OutputStream	getOutputStream(String vfsFilename, boolean append)
OutputStream	getOutputStream(String vfsFilename, VariableSpace space, boolean append)
OutputStream	getOutputStream(String vfsFilename, VariableSpace space, org.apache.commons.vfs2.FileSystemOptions fsOptions, boolean append)
OutputStream	getOutputStream(org.apache.commons.vfs2.FileObject fileObject, boolean append)
String	getTextFileContent(String vfsFilename, String charSetName)	Deprecated. use getInstance( Bowl )
String	getTextFileContent(String vfsFilename, VariableSpace space, String charSetName)
void	reset()	resets the VariableSpace
org.apache.commons.vfs2.FileName	resolveURI(String uri)	Resolves the given URI to a file name.

Method Details

getFileObject

org.apache.commons.vfs2.FileObject getFileObject(String vfsFilename)
                                          throws KettleFileException

Throws:

KettleFileException

getFileObject

org.apache.commons.vfs2.FileObject getFileObject(String vfsFilename,
 VariableSpace space)
                                          throws KettleFileException

Throws:

KettleFileException

getFileObject

org.apache.commons.vfs2.FileObject getFileObject(String vfsFilename,
 org.apache.commons.vfs2.FileSystemOptions fsOptions)
                                          throws KettleFileException

Throws:

KettleFileException

getFileObject

org.apache.commons.vfs2.FileObject getFileObject(String vfsFilename,
 VariableSpace space,
 org.apache.commons.vfs2.FileSystemOptions fsOptions)
                                          throws KettleFileException

Throws:

KettleFileException

resolveURI

org.apache.commons.vfs2.FileName resolveURI(String uri)
                                     throws KettleFileException

Resolves the given URI to a file name.

Parameters:

uri - The URI to resolve.

Returns:

A FileName that matches the URI; never null.

Throws:

KettleFileException - if this is not possible.

getFileSystemOptions

org.apache.commons.vfs2.FileSystemOptions getFileSystemOptions(String scheme,
 String vfsFilename,
 VariableSpace space,
 org.apache.commons.vfs2.FileSystemOptions fileSystemOptions)
                                                        throws IOException

Throws:

IOException

getFriendlyURI

String getFriendlyURI(String filename)

getFriendlyURI

String getFriendlyURI(String filename,
 VariableSpace space)

getTextFileContent

String getTextFileContent(String vfsFilename,
 String charSetName)
                   throws KettleFileException

Deprecated.

use getInstance( Bowl )

Read a text file (like an XML document). WARNING DO NOT USE FOR DATA FILES.

Parameters:

vfsFilename - the filename or URL to read from

charSetName - the character set of the string (UTF-8, ISO8859-1, etc)

Returns:

The content of the file as a String

Throws:

IOException

KettleFileException

getTextFileContent

String getTextFileContent(String vfsFilename,
 VariableSpace space,
 String charSetName)
                   throws KettleFileException

Throws:

KettleFileException

fileExists

boolean fileExists(String vfsFilename)
            throws KettleFileException

Throws:

KettleFileException

fileExists

boolean fileExists(String vfsFilename,
 VariableSpace space)
            throws KettleFileException

Throws:

KettleFileException

getInputStream

InputStream getInputStream(String vfsFilename)
                    throws KettleFileException

Throws:

KettleFileException

getInputStream

InputStream getInputStream(String vfsFilename,
 VariableSpace space)
                    throws KettleFileException

Throws:

KettleFileException

getOutputStream

OutputStream getOutputStream(org.apache.commons.vfs2.FileObject fileObject,
 boolean append)
                      throws IOException

Throws:

IOException

getOutputStream

OutputStream getOutputStream(String vfsFilename,
 boolean append)
                      throws KettleFileException

Throws:

KettleFileException

getOutputStream

OutputStream getOutputStream(String vfsFilename,
 VariableSpace space,
 boolean append)
                      throws KettleFileException

Throws:

KettleFileException

getOutputStream

OutputStream getOutputStream(String vfsFilename,
 VariableSpace space,
 org.apache.commons.vfs2.FileSystemOptions fsOptions,
 boolean append)
                      throws KettleFileException

Throws:

KettleFileException

createTempFile

org.apache.commons.vfs2.FileObject createTempFile(String prefix,
 KettleVFS.Suffix suffix)
                                           throws KettleFileException

Creates a file using "java.io.tmpdir" directory

Parameters:

prefix - - file name

prefix - - file extension

Returns:

FileObject

Throws:

KettleFileException

createTempFile

org.apache.commons.vfs2.FileObject createTempFile(String prefix,
 KettleVFS.Suffix suffix,
 VariableSpace variableSpace)
                                           throws KettleFileException

Creates a file using "java.io.tmpdir" directory

Parameters:

prefix - - file name

suffix - - file extension

variableSpace - is used to get system variables

Returns:

FileObject

Throws:

KettleFileException

createTempFile

org.apache.commons.vfs2.FileObject createTempFile(String prefix,
 KettleVFS.Suffix suffix,
 String directory)
                                           throws KettleFileException

Parameters:

prefix - - file name

suffix - - file extension

directory - - directory where file will be created

Returns:

FileObject

Throws:

KettleFileException

createTempFile

org.apache.commons.vfs2.FileObject createTempFile(String prefix,
 String suffix,
 String directory)
                                           throws KettleFileException

Throws:

KettleFileException

createTempFile

org.apache.commons.vfs2.FileObject createTempFile(String prefix,
 KettleVFS.Suffix suffix,
 String directory,
 VariableSpace space)
                                           throws KettleFileException

Parameters:

prefix - - file name

directory - path to directory where file will be created

space - is used to get system variables

Returns:

FileObject

Throws:

KettleFileException

createTempFile

org.apache.commons.vfs2.FileObject createTempFile(String prefix,
 String suffix,
 String directory,
 VariableSpace space)
                                           throws KettleFileException

Throws:

KettleFileException

reset

void reset()

resets the VariableSpace