Package com.vordel.es

This package contains the Entity Store interface and other classes which together constitute the Entity Store framework.

See: Description

Interface Summary

Interface	Description
EntityStore	The EntityStore interface defines a common contract for access to all providers of the EntityStore service.
EntityType	The type definition for Entities in the EntityStore framework
EntityTypeFactory
ESChangeListener	Not implemented server side. The interface which must be implemented by interested parties to listen for Entity change events on the EntityStore.
ESPK	An interface for a unique Entity identifier.
KeyHolder	Interface for any object that contains an ESPK.
TypeStore	Defines a common interface for retrieving Entity type information, EntityTypes, which in turn describe Entity structure.

Class Summary

Class	Description
ConstantFieldType	Special FieldType to distinguish constant Fields from normal Fields.
Entity	The main component in the EntityStore.
EntityBranch
EntityComparator	Compare entities for sorting functionality.
EntityStoreDelegate	Holding area for extended ES functionality which may be candidates for inclusion into the EntityStore interface proper in the future.
EntityStoreDelegate.TypedFieldEntity	Store an Entity which has a field(s)of the specified type and a list of the names of those fields.
EntityStoreFactory	The place to come to when you want to get an EntityStore which will understand your particular flavor of URL.
EntityTypeFactoryImpl
EntityTypeImpl	The type definition for Entities in the EntityStore framework
ESChangeListenerAdapter	Convienence class which implements the ESChangeListener interface.
Field	A Field is a typed component part of an Entity, containing zero, one or more values.
FieldType	A FieldType defines the type of a specific Field for a given EntityType.
ReferenceRecorder
Value	A Value can represent either a data value (in the form of a String), or a reference to some Entity (in the form of an ESPK).

Exception Summary

Exception	Description
DuplicateKeysException
EntityStoreException	Specialization of Exception for problems which can occur in the course of using the EntityStore framework.
IncompatibleTypeException
UnknownTypeException

Package com.vordel.es Description

This package contains the Entity Store interface and other classes which together constitute the Entity Store framework. This framework provides a common, datastore-neutral way of storing and accessing data.

Several implementations of the Entity Store are available by default, which use underlying stores such as LDAP, Oracle, MySQL, MsSQL and Flat File . The store you retrieve from the factory is determined by the URL you use to request an ES instance, and whether the ES provider for that flavor of URL has been registered with the factory at initialization.

Noteworthy classes in this package are:

• EntityStore(specializing TypeStore) The common interface to all Entity Store implementations
• Entity The core unit of data in the EntityStore
• EntityType Each Entity has an EntityType
• ESPK The unique key for an Entity
• EntityStoreFactory Where we get a handle to an EntityStore instance
• EntityStoreException When something goes wrong in the Entity Store framework, it usually results in one of these.
• EntityStoreDelegate Convenience singleton for manipulation of Entities in a store.