org.rapidcontext.core.storage

Class Index

java.lang.Object

org.rapidcontext.core.storage.StorableObject

org.rapidcontext.core.storage.Index

public class Index
extends StorableObject

An index dictionary. An index is an object containing the names of objects and sub-indices.

IMPORTANT: The index objects shouldn't be modified directly by outside the owning storage implementation. Use the copy() method to create a copy if changes need to be made elsewhere.

Version:

1.0

Author:

Per Cederberg

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_IDXS The dictionary key for the array of indices.
static java.lang.String	KEY_MODIFIED The dictionary key for the last modified date.
static java.lang.String	KEY_OBJS The dictionary key for the array of objects.
static java.lang.String	KEY_PATH The dictionary key for the storage path.

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

dict, KEY_CLASSNAME, KEY_ID, KEY_TYPE

Constructor Summary

Constructors

Constructor and Description
Index(Path path) Creates a new empty index.
Index(Path path, Array indices, Array objects) Creates a new index with the specified entries.

Method Summary

Modifier and Type	Method and Description
boolean	addIndex(java.lang.String name) Adds a sub-index name.
boolean	addObject(java.lang.String name) Adds an object name.
Array	indices() Returns an array of sub-index names.
java.util.Date	lastModified() Returns the last modified date.
static Index	merge(Index one, Index two) Merges two index dictionaries.
Array	objects() Returns an array of object names.
Path	path() Returns the storage path for the index.
Array	paths() Returns an array of paths corresponding to all sub-indexes and objects in this index.
boolean	removeIndex(java.lang.String name) Removes a sub-index name.
boolean	removeObject(java.lang.String name) Removes an object name.
void	updateLastModified(java.util.Date date) Updates the last modified date.

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_PATH

public static final java.lang.String KEY_PATH

The dictionary key for the storage path. The value stored is a Path object.

See Also:

Constant Field Values

KEY_MODIFIED

public static final java.lang.String KEY_MODIFIED

The dictionary key for the last modified date. The value stored is a Date object.

See Also:

Constant Field Values

KEY_IDXS

public static final java.lang.String KEY_IDXS

The dictionary key for the array of indices.

See Also:

Constant Field Values

KEY_OBJS

public static final java.lang.String KEY_OBJS

The dictionary key for the array of objects.

See Also:

Constant Field Values

Constructor Detail

Index

public Index(Path path)

Creates a new empty index.

Parameters:

path - the storage path for the index

Index

public Index(Path path,
             Array indices,
             Array objects)

Creates a new index with the specified entries.

Parameters:

path - the storage path for the index

indices - the initial index array

objects - the initial object array

Method Detail

merge

public static Index merge(Index one,
                          Index two)

Merges two index dictionaries. Note that this may modify one of the two directories.

Parameters:

one - the first index dictionary

two - the second index dictionary

Returns:

the merged index

path

public Path path()

Returns the storage path for the index.

Overrides:

path in class StorableObject

Returns:

the storage path for the index

lastModified

public java.util.Date lastModified()

Returns the last modified date.

Returns:

the last modified date

updateLastModified

public void updateLastModified(java.util.Date date)

Updates the last modified date.

Parameters:

date - the date to set, or null for now

indices

public Array indices()

Returns an array of sub-index names.

Returns:

an array of sub-index names

objects

public Array objects()

Returns an array of object names.

Returns:

an array of object names

paths

public Array paths()

Returns an array of paths corresponding to all sub-indexes and objects in this index.

Returns:

an array of path objects

addIndex

public boolean addIndex(java.lang.String name)

Adds a sub-index name. The name will only be added only if not already in the index.

Parameters:

name - the index name

Returns:

true if the name was added to the index, or false otherwise

addObject

public boolean addObject(java.lang.String name)

Adds an object name. The name will only be added only if not already in the index.

Parameters:

name - the object name

Returns:

true if the name was added to the index, or false otherwise

removeIndex

public boolean removeIndex(java.lang.String name)

Removes a sub-index name.

Parameters:

name - the index name

Returns:

true if the name was removed from the index, or false otherwise

removeObject

public boolean removeObject(java.lang.String name)

Removes an object name.

Parameters:

name - the object name

Returns:

true if the name was removed from the index, or false otherwise