er.extensions.foundation

Class ERXFileRepository

java.lang.Object

er.extensions.foundation.ERXFileRepository

public class ERXFileRepository
extends Object

Allows you to store a large amount of files and folders without the hassles of directory size limitations. The files are stored by an abstract "key" which is by default a UUID.

It uses a factory to create the folder structure under the root directory. With the default factory there will be directories for the first two characters and under these again directories for the next two characters of the GUID.

Author:

ak (original version by Dominik Westner)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXFileRepository.DefaultFactory Default implementation of the Factory interface.
static interface	ERXFileRepository.Factory

Field Summary

Fields

Modifier and Type	Field and Description
protected ERXFileRepository.Factory	_factory
protected File	_root

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ERXFileRepository(File root, ERXFileRepository.Factory factory) Private constructor, as we use the factory methods to create instances.

Method Summary

Modifier and Type	Method and Description
static ERXFileRepository	addRepository(String name, ERXFileRepository repository) Adds an existing repository under the given name.
static ERXFileRepository	addRepository(String name, File root) Adds a repository under the given name and the given root directory that uses the default factory.
static ERXFileRepository	addRepository(String name, File root, ERXFileRepository.Factory factory) Adds a repository under the given name and the given root directory that uses the given factory.
File	createFile() Returns a new file in the repository.
File	getFile(String id) Returns a file for a given id
File	getRoot() Returns the root directory for the repository.
boolean	hasFile(String id) Returns true if the file is present in the repository and also exists.
static ERXFileRepository	repository(String name) Returns the repository that is registered under the given name.

Methods inherited from class java.lang.Object

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

Field Detail

_root

protected File _root

_factory

protected final ERXFileRepository.Factory _factory

Constructor Detail

ERXFileRepository

protected ERXFileRepository(File root,
                            ERXFileRepository.Factory factory)

Private constructor, as we use the factory methods to create instances.

Parameters:

root -

factory -

Method Detail

createFile

public File createFile()

Returns a new file in the repository. As you can also create directories it does not really create the file, only the path to the file. You can use file.getName() to get at the GUID which is the key to the file.

Returns:

the new file

getFile

public File getFile(String id)

Returns a file for a given id

Parameters:

id - the id of the file

Returns:

a file for the given id

hasFile

public boolean hasFile(String id)

Returns true if the file is present in the repository and also exists.

Parameters:

id - the id of the file

Returns:

true if the file exists in the repository

getRoot

public File getRoot()

Returns the root directory for the repository.

Returns:

the root directory for the repository

repository

public static ERXFileRepository repository(String name)

Returns the repository that is registered under the given name.

Parameters:

name - the name under which the repository is registered

Returns:

the repository that is registered under the given name or null

addRepository

public static ERXFileRepository addRepository(String name,
                                              File root)

Adds a repository under the given name and the given root directory that uses the default factory.

Parameters:

name - the name under which the repository should be added

root - the root directory of the repository

Returns:

the new repository

addRepository

public static ERXFileRepository addRepository(String name,
                                              File root,
                                              ERXFileRepository.Factory factory)

Adds a repository under the given name and the given root directory that uses the given factory.

Parameters:

name - the name under which the repository should be added

root - the root directory of the repository

factory - the factory to determine the directory from the id for this repository

Returns:

the new repository

addRepository

public static ERXFileRepository addRepository(String name,
                                              ERXFileRepository repository)

Adds an existing repository under the given name.

Parameters:

name - the name under which the repository should be added

repository - the repository to register

Returns:

the repository