org.rapidcontext.core.storage

Class DirStorage

java.lang.Object

org.rapidcontext.core.storage.StorableObject

org.rapidcontext.core.storage.Storage

org.rapidcontext.core.storage.DirStorage

All Implemented Interfaces:

java.lang.Comparable

public class DirStorage
extends Storage

A persistent data storage and retrieval handler based on a file system directory. This class will read and write both Java property files and binary files depending on the object type provided. The property files are used for all dictionary data storage and retrieval.

Version:

1.0

Author:

Per Cederberg

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_DIR The dictionary key for the base directory.
static java.lang.String	SUFFIX_PROPS The file suffix used for properties files.

Fields inherited from class org.rapidcontext.core.storage.Storage

KEY_MOUNT_OVERLAY_PATH, KEY_MOUNT_OVERLAY_PRIO, KEY_MOUNT_PATH, KEY_MOUNT_TIME, KEY_READWRITE, PATH_STORAGE, PATH_STORAGE_CACHE, PATH_STORAGEINFO

Fields inherited from class org.rapidcontext.core.storage.StorableObject

dict, KEY_CLASSNAME, KEY_ID, KEY_TYPE

Constructor Summary

Constructors

Constructor and Description
DirStorage(java.io.File dir, boolean readWrite) Creates a new directory storage.

Method Summary

Modifier and Type	Method and Description
java.io.File	dir() Returns the base directory for the storage data files.
java.lang.Object	load(Path path) Loads an object from the specified location.
Metadata	lookup(Path path) Searches for an object at the specified location and returns metadata about the object if found.
void	remove(Path path) Removes an object or an index at the specified location.
void	store(Path path, java.lang.Object data) Stores an object at the specified location.

Methods inherited from class org.rapidcontext.core.storage.Storage

compareTo, isReadWrite, loadAll, localPath, lookupAll, mountOverlayPath, mountOverlayPrio, mountTime, path, setMountInfo

Methods inherited from class org.rapidcontext.core.storage.StorableObject

activate, destroy, id, init, isActive, isModified, passivate, serialize, toString, type

Methods inherited from class java.lang.Object

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

Field Detail

KEY_DIR

public static final java.lang.String KEY_DIR

The dictionary key for the base directory. The value stored is a file object.

See Also:

Constant Field Values

SUFFIX_PROPS

public static final java.lang.String SUFFIX_PROPS

The file suffix used for properties files. These files are used for serializing dictionary objects to files.

See Also:

Constant Field Values

Constructor Detail

DirStorage

public DirStorage(java.io.File dir,
                  boolean readWrite)

Creates a new directory storage.

Parameters:

dir - the base data directory to use

readWrite - the read write flag

Method Detail

dir

public java.io.File dir()

Returns the base directory for the storage data files.

Returns:

the base directory for data files

lookup

public Metadata lookup(Path path)

Searches for an object at the specified location and returns metadata about the object if found. The path may locate either an index or a specific object.

Specified by:

lookup in class Storage

Parameters:

path - the storage location

Returns:

the metadata for the object, or null if not found

load

public java.lang.Object load(Path path)

Loads an object from the specified location. The path may locate either an index or a specific object. In case of an index, the data returned is an index dictionary listing of all objects in it.

Specified by:

load in class Storage

Parameters:

path - the storage location

Returns:

the data read, or null if not found

store

public void store(Path path,
                  java.lang.Object data)
           throws StorageException

Stores an object at the specified location. The path must locate a particular object or file, since direct manipulation of indices is not supported. Any previous data at the specified path will be overwritten or removed. Note that only dictionaries and files can be stored in a file storage.

Specified by:

store in class Storage

Parameters:

path - the storage location

data - the data to store

Throws:

StorageException - if the data couldn't be written

remove

public void remove(Path path)
            throws StorageException

Removes an object or an index at the specified location. If the path refers to an index, all contained objects and indices will be removed recursively.

Specified by:

remove in class Storage

Parameters:

path - the storage location

Throws:

StorageException - if the data couldn't be removed