B C D E F G H I J L M N O P Q R S T U

B

BATCH_MODE - Static variable in class net.sourceforge.floggy.persistence.PersistableManager

batchSave(Persistable) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Store an object in the repository, it will always create a new entry on the repository.
The main use of this method is to import data from a remote source.
Set the property BATCH_MODE to true to improve the performance and create only one object to save the data.

C

className - Variable in class net.sourceforge.floggy.persistence.migration.FieldPersistableInfo

The Persistable's class name

Comparator - Interface in net.sourceforge.floggy.persistence

An interface defining a comparator which compares two objects (in an implementation-defined manner) to see if they match or what their relative sort order is.

compare(Persistable, Persistable) - Method in interface net.sourceforge.floggy.persistence.Comparator

Returns Comparator.PRECEDES if o1 precedes o2 in sort order, or Comparator.FOLLOWS if o1 follows o2 in sort order, or Comparator.EQUIVALENT if o1 and o2 are equivalent in terms of sort order.

D

Deletable - Interface in net.sourceforge.floggy.persistence

An interface that helps the developer to delete in cascade Persistable fields.

delete() - Method in interface net.sourceforge.floggy.persistence.Deletable

It is used to clean up references that the implementation class may have to another entities.

delete() - Method in interface net.sourceforge.floggy.persistence.migration.Enumeration

Delete the current record.

delete(Persistable) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Removes an object from the repository.

deleteAll() - Method in class net.sourceforge.floggy.persistence.PersistableManager

Removes all objects from the repository.

deleteAll(Class) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Removes all objects that belongs to the class passed as parameter from the repository.

E

Enumeration - Interface in net.sourceforge.floggy.persistence.migration

A Enumeration to be used in the updating process.

equals(Object) - Method in class net.sourceforge.floggy.persistence.migration.FieldPersistableInfo

EQUIVALENT - Static variable in interface net.sourceforge.floggy.persistence.Comparator

EQUIVALENT means that in terms of search or sort order, the two objects are the same.

F

FieldPersistableInfo - Class in net.sourceforge.floggy.persistence.migration

Represents a Persistable information in the update process.

FieldPersistableInfo(int, String) - Constructor for class net.sourceforge.floggy.persistence.migration.FieldPersistableInfo

Creates a new FieldPersistableInfo object.

Filter - Interface in net.sourceforge.floggy.persistence

An interface defining a filter which examines a object to see if it matches (based on an application-defined criteria).

find(Class, Filter, Comparator) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Searches objects of an especific persistable class from the repository.

find(Class, IndexFilter, boolean) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Searches objects of a specific persistable class from the repository.

find(Class, Filter, Comparator, boolean) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Searches objects of a specific persistable class from the repository.

finish(Class) - Method in class net.sourceforge.floggy.persistence.migration.MigrationManager

Finish the whole migration process.

FloggyException - Exception in net.sourceforge.floggy.persistence

Exception thrown to indicate a persistence problem.

FloggyException(String) - Constructor for exception net.sourceforge.floggy.persistence.FloggyException

Construct a new FloggyException with a specified detail message.

FloggyException(String, Throwable) - Constructor for exception net.sourceforge.floggy.persistence.FloggyException

Construct a new FloggyException with a specified detail message and root cause.

FOLLOWS - Static variable in interface net.sourceforge.floggy.persistence.Comparator

FOLLOWS means that the left (first parameter) object follows the right (second parameter) object in terms of search or sort order.

The value of FOLLOWS is 1.

G

get(int) - Method in interface net.sourceforge.floggy.persistence.ObjectSet

Load the object at the specified index.

get(int, Persistable) - Method in interface net.sourceforge.floggy.persistence.SingleObjectSet

Deprecated. Use the getSharedInstance instead of it.

getClassName() - Method in class net.sourceforge.floggy.persistence.migration.FieldPersistableInfo

Gets the class name

getId() - Method in class net.sourceforge.floggy.persistence.migration.FieldPersistableInfo

Gets the id

getId(Persistable) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Gets the id under the persistable is stored.

getId(int) - Method in interface net.sourceforge.floggy.persistence.SingleObjectSet

Load the object of a given index into the object instance supplied.

getIndexName() - Method in class net.sourceforge.floggy.persistence.IndexFilter

DOCUMENT ME!

getIndexValue() - Method in class net.sourceforge.floggy.persistence.IndexFilter

DOCUMENT ME!

getInstance() - Static method in class net.sourceforge.floggy.persistence.migration.MigrationManager

Returns the current instance of PersistableManager.

getInstance() - Static method in class net.sourceforge.floggy.persistence.PersistableManager

Returns the current instance of PersistableManager.

getNotMigratedClasses() - Method in class net.sourceforge.floggy.persistence.migration.MigrationManager

Retrieves a list with all classes that needs to be migrated.

getProperty(String) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Get a property

getRecordStoreName() - Method in interface net.sourceforge.floggy.persistence.Nameable

Deprecated. use the configuration file to set the RecordStore's name

getRootCause() - Method in exception net.sourceforge.floggy.persistence.FloggyException

Gets the root cause if any of the current throwable

getSharedInstance(int) - Method in interface net.sourceforge.floggy.persistence.ObjectSet

Returns the object at the specified index.

getSize() - Method in interface net.sourceforge.floggy.persistence.migration.Enumeration

Gets the size of the enumeration.

H

hashCode() - Method in class net.sourceforge.floggy.persistence.migration.FieldPersistableInfo

hasMoreElements() - Method in interface net.sourceforge.floggy.persistence.migration.Enumeration

Tests if this enumeration contains more elements.

I

id - Variable in class net.sourceforge.floggy.persistence.migration.FieldPersistableInfo

The Persistable's id

IDable - Interface in net.sourceforge.floggy.persistence

Exports the RMS id used to identify the Persistable entity in the underlined system.

IndexFilter - Class in net.sourceforge.floggy.persistence

An class defining a filter which matches a objects (based on an application-defined index).

IndexFilter(String, Object) - Constructor for class net.sourceforge.floggy.persistence.IndexFilter

Creates a new IndexFilter object.

indexName - Variable in class net.sourceforge.floggy.persistence.IndexFilter

indexValue - Variable in class net.sourceforge.floggy.persistence.IndexFilter

isLazy() - Method in interface net.sourceforge.floggy.persistence.ObjectSet

Gets the lazy property.

isPersisted(Persistable) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Check if the object is already persisted.

ITERATION_MODE - Static variable in class net.sourceforge.floggy.persistence.migration.MigrationManager

It enables the developer to iterate over all registers without update or delete it.

J

JoinedStrategy - Interface in net.sourceforge.floggy.persistence.strategy

DOCUMENT ME!

L

LAZY_LOAD - Static variable in class net.sourceforge.floggy.persistence.migration.MigrationManager

It drives the migration avoiding or not the loading of Persistable fields

load(Persistable, int) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Load an previously stored object from the repository using the object ID.
The object ID is the result of a save operation or you can obtain it executing a search.

load(Persistable, int, boolean) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Load an previously stored object from the repository using the object ID.
The object ID is the result of a save operation or you can obtain it executing a search.

M

matches(Persistable) - Method in interface net.sourceforge.floggy.persistence.Filter

Returns true if the candidate object matches the implemented criterion.

MIGRATE_FROM_PREVIOUS_1_3_0_VERSION - Static variable in class net.sourceforge.floggy.persistence.migration.MigrationManager

It enables the developer to migrate from a version earlier than 1.3.0

MigrationManager - Class in net.sourceforge.floggy.persistence.migration

A class that helps the developer migrate from a previous version of its application to a new version.

MigrationManager() - Constructor for class net.sourceforge.floggy.persistence.migration.MigrationManager

N

Nameable - Interface in net.sourceforge.floggy.persistence

Deprecated. use the configuration file to set the RecordStore's name

net.sourceforge.floggy.persistence - package net.sourceforge.floggy.persistence

Provides an API to manage the persistence mechanism of Floggy.

net.sourceforge.floggy.persistence.migration - package net.sourceforge.floggy.persistence.migration

net.sourceforge.floggy.persistence.strategy - package net.sourceforge.floggy.persistence.strategy

nextElement() - Method in interface net.sourceforge.floggy.persistence.migration.Enumeration

Returns the next element of this enumeration if this enumeration object has at least one more element to provide.

O

ObjectSet - Interface in net.sourceforge.floggy.persistence

An interface representing a search result.

P

PerClassStrategy - Interface in net.sourceforge.floggy.persistence.strategy

DOCUMENT ME!

Persistable - Interface in net.sourceforge.floggy.persistence

A class that implements or extends this interface is considered persistable.

By default, all fields of a persistable class will be persisted except those declared as transient or static.

PersistableManager - Class in net.sourceforge.floggy.persistence

This is the main class of the framework.

PersistableManager() - Constructor for class net.sourceforge.floggy.persistence.PersistableManager

polymorphicFind(Class, Filter, boolean) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Searches objects of an persistable class and its subclasses from the repository.

PolymorphicObjectSet - Interface in net.sourceforge.floggy.persistence

An interface representing a search result.

PRECEDES - Static variable in interface net.sourceforge.floggy.persistence.Comparator

PRECEDES means that the left (first parameter) object precedes the right (second parameter) object in terms of search or sort order.

The value of PRECEDES is -1.

printStackTrace() - Method in exception net.sourceforge.floggy.persistence.FloggyException

DOCUMENT ME!

Q

quickMigration(Class) - Method in class net.sourceforge.floggy.persistence.migration.MigrationManager

Execute a quick migration in classes that didn't changed between versions.

R

rootCause - Variable in exception net.sourceforge.floggy.persistence.FloggyException

The root cause

S

save(Persistable) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Store an object in the repository.

setId(int) - Method in interface net.sourceforge.floggy.persistence.IDable

Setter method to the id field.

setIndexName(String) - Method in class net.sourceforge.floggy.persistence.IndexFilter

DOCUMENT ME!

setIndexValue(Object) - Method in class net.sourceforge.floggy.persistence.IndexFilter

DOCUMENT ME!

setLazy(boolean) - Method in interface net.sourceforge.floggy.persistence.ObjectSet

Sets the lazy property.

setProperty(String, Object) - Method in class net.sourceforge.floggy.persistence.PersistableManager

Set a property

shutdown() - Method in class net.sourceforge.floggy.persistence.PersistableManager

Shutdown the PersistableManager.

SingleObjectSet - Interface in net.sourceforge.floggy.persistence

An interface representing a search result.

SingleStrategy - Interface in net.sourceforge.floggy.persistence.strategy

DOCUMENT ME!

size() - Method in interface net.sourceforge.floggy.persistence.ObjectSet

Returns the number of objects in this set.

start(Class, Hashtable) - Method in class net.sourceforge.floggy.persistence.migration.MigrationManager

Start the migration process of the given Persistable class.

STORE_INDEX_AFTER_SAVE_OPERATION - Static variable in class net.sourceforge.floggy.persistence.PersistableManager

T

toString() - Method in class net.sourceforge.floggy.persistence.migration.FieldPersistableInfo

U

update(Persistable) - Method in interface net.sourceforge.floggy.persistence.migration.Enumeration

Update the current record with the Persistable parameter.

B C D E F G H I J L M N O P Q R S T U