org.gramar.filestore

Class LocalFileStore

java.lang.Object

org.gramar.filestore.FileStore

org.gramar.filestore.LocalFileStore

All Implemented Interfaces:

IFileStore

public class LocalFileStore
extends FileStore
implements IFileStore

An implementation of IFileStore that stores files on the local file system. An absolute directory path is specified on the constructor and all projects are assumed to be subdirectories of that directory

Author:

chrisgerken

Field Summary

Fields inherited from class org.gramar.filestore.FileStore

updates

Constructor Summary

Constructors

Constructor and Description
LocalFileStore()
LocalFileStore(String rootDir) Convenience constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(Properties properties) Configure the filestore with values from the given properties file.
void	createFolder(String pathName)
void	createProject(String projectName, String path) Create a target project with the given name.
InputStream	getFileByteContent(String path) Retrieve the content of the specified file.
Reader	getFileContent(String path) Retrieve the content of the specified file.
void	log(String message) Logs a message in a FileStore-appropriate way
void	reset() Initialize to prepare for gramar application.
boolean	resourceExists(String path) Answers a boolean indicating that the resource at the given path exists (true) or that it does not (false)
void	setFileContent(String path, InputStream stream) Store the content of the specified file.
void	setFileContent(String path, Reader reader) Store the content of the specified file.

Methods inherited from class org.gramar.filestore.FileStore

addUpdate, commit, executeUpdates, free, sameBytes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gramar.IFileStore

addUpdate, commit, free, sameBytes

Constructor Detail

LocalFileStore

public LocalFileStore()

LocalFileStore

public LocalFileStore(String rootDir)

Convenience constructor

Parameters:

rootDir -

Method Detail

getFileByteContent

public InputStream getFileByteContent(String path)
                               throws NoSuchResourceException

Description copied from interface: IFileStore

Retrieve the content of the specified file. The path is assumed to start at a project within the file store.

Specified by:

getFileByteContent in interface IFileStore

Throws:

NoSuchResourceException

setFileContent

public void setFileContent(String path,
                  InputStream stream)
                    throws NoSuchResourceException

Description copied from interface: IFileStore

Store the content of the specified file. The path is assumed to start at a project within the file store.

Specified by:

setFileContent in interface IFileStore

Throws:

NoSuchResourceException

getFileContent

public Reader getFileContent(String path)

Description copied from interface: IFileStore

Retrieve the content of the specified file. The path is assumed to start at a project within the file store. Used mostly by user region and load support

Specified by:

getFileContent in interface IFileStore

setFileContent

public void setFileContent(String path,
                  Reader reader)
                    throws NoSuchResourceException

Description copied from interface: IFileStore

Store the content of the specified file. The path is assumed to start at a project within the file store.

Specified by:

setFileContent in interface IFileStore

Throws:

NoSuchResourceException

resourceExists

public boolean resourceExists(String path)

Description copied from interface: IFileStore

Answers a boolean indicating that the resource at the given path exists (true) or that it does not (false)

Specified by:

resourceExists in interface IFileStore

createProject

public void createProject(String projectName,
                 String path)

Description copied from interface: IFileStore

Create a target project with the given name. If non null or blank, the altPath represents a store-dependent alternate or relative location to be used in the creation of the project

Specified by:

createProject in interface IFileStore

createFolder

public void createFolder(String pathName)
                  throws NoSuchResourceException

Specified by:

createFolder in interface IFileStore

Throws:

NoSuchResourceException

reset

public void reset()

Description copied from interface: IFileStore

Initialize to prepare for gramar application. Does not change the state of any resources.

Specified by:

reset in interface IFileStore

Overrides:

reset in class FileStore

log

public void log(String message)

Description copied from interface: IFileStore

Logs a message in a FileStore-appropriate way

Specified by:

log in interface IFileStore

configure

public void configure(Properties properties)
               throws GramarException

Description copied from interface: IFileStore

Configure the filestore with values from the given properties file.

Specified by:

configure in interface IFileStore

Overrides:

configure in class FileStore

Throws:

GramarException