Holger's Java API

## Uses of Package
com.antelmann.db

Packages that use com.antelmann.db
com.antelmann.calendar: This package contains classes for implementing calendar and time related solutions.
com.antelmann.crm: Provides interfaces and classes for implementing applications dealing with Customer Relationship Management (CRM).
com.antelmann.db: This package contains generally useful classes for generic database management.
com.antelmann.db.remote: This package contains classes that add remote capacities to the database concept of the super package.
com.antelmann.genealogy: This package contains classes that provide classes to implement applications dealing with genealogy related issues.
com.antelmann.genealogy.db: This package provides implementations that manage the persistence for the genealogy package.
com.antelmann.image: This package contains classes for more easily dealing with images.
com.antelmann.io: This package contains classes that are concerned with input/output operations.
com.antelmann.math: This package contains classes to ease calculations.
com.antelmann.net.mail: The classes in this package are designed to ease the handling of emails.
com.antelmann.net.web: This package contains classes for dealing with Web-related content.
com.antelmann.opengeodb: This package contains classes easing to deal with geological data as provided by http://opengeodb.org/.
com.antelmann.servlet: This package contains classes to help with the implementation of servlets.
com.antelmann.sql: This package contains classes to ease JDBC development and also provides useful SQL-based implementations for com.antelmann.db classes
com.antelmann.util: This package contains generally useful classes that are used throughout the other packages in this framework.
com.antelmann.util.gui: This package contains utility classes for GUI related implementations.
com.antelmann.util.revision: This package contains classes useful for implementing systems that deal with revisions.
com.antelmann.webdav: provides higher level access for WebDAV, CalDAV and CardDAV clients.

Classes in com.antelmann.db used by com.antelmann.calendar
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.

Classes in com.antelmann.db used by com.antelmann.crm
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBReference DBReference represents an Object that can hold a reference to a DBEntry object, providing sufficient means to retrieve that object from a Database.
DefaultEntryRelationship a default implementation for an EntryRelationship
DefaultSpecialRelationship provides a default implementation for SpecialRelationships.
EntryRelationship represents a relationship between two `DBEntry` instances.
IDFactory provides a way for an application to centralize the creation of new IDs for DBEntry instances
Keyword implements a Group/Tag solely based on a String that also represents the ID for the `DBEntry` it is.
ProcessedFilterOption allows to control whether a processor is run before filtering when using a `WrappedDBClassStore`.
PropertyEntry represents an entity that is specified by various properties that may flexibly change.
PropertyEntryImpl This class represents a default PropertyEntry implementation that can serve as a base class for PropertyEntry implementations.
SpecialRelationship a relationship definition specifying the classes that may be connected as well as the type of relation
Stub a Stub is a small object that can serve as a proxy for larger objects, so that you can maintain a lot of these in memory and only access the full object if needed.
Taggable represents an object that can be a member of several groups
TransactionRequired This annotation suggests that implementations of these methods (or all methods of that type) should always be called only in a proper transactional context.
WrappedDBClassStore a generic DBClassStore wrapper easing the implementation of special wrappers.
WrongDataException WrongDataException signals a consistency problem with the data submitted to the database.

Classes in com.antelmann.db used by com.antelmann.db
AbstractDBClassStore provides basic implementation of methods that can be implemented based on other methods of the interface - though these implementations may be very inefficient
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
AbstractDBEnumeration a base for making it easy to implement `DBEnumeration`.
AbstractUserLoginStore a base for easily implementing a UserLoginStore.
ArchivedStore allows to control the archive option of a supporting `DBClassStore`
Category represents a category that may be associated with any kind of entry and supports cascading sub-categories
Category.Adapter
Category.Entry
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseChangeListener listens for committed changes through DBClassStore objects in a database and propagates the information to its listeners.
DatabaseChangeMonitor listens to database events and propagates committed changes in a database to its DatabaseChangeListeners to its listeners.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBAccessController used to control access on database resources in an `AbstractDatabase`.
DBAccessDeniedWarning thrown to indicate that access to a database was not allowed due to applicable restrictions
DBAccessLoggerLevel used as a level to log database access
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
DBClassStore.DBMethod
DBConfigListener listens to events that change the configuration of the database
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBEnumeration a special Enumeration that allows to release its resources even though a caller has not completely iterated through this instance.
DBReference DBReference represents an Object that can hold a reference to a DBEntry object, providing sufficient means to retrieve that object from a Database.
DBStoreListener listens for database updates and access through DBClassStore objects
DBStoreListener.Adapter provides convenient empty implementations for all methods
DBStoreProfiler allows to easily profile a store.
DBStoreProfiler.ProfileModel the profile model is a read-only snapshot of the given profile.
DBTransaction a transaction controlls access to all resources of a Database through DBClassStore instances.
DBUpdateEvent
DBVetoException thrown to indicate that a listener disagreed with an update of the database
DefaultDBReference this class implements a simple DBReference object.
DefaultEntryRelationship a default implementation for an EntryRelationship
DocumentEntry specifies a general-purpose document that can be managed in a database
EntryClassMapper this interface maps between DBEntry classes and some Object that allows its external storage and retrieval and custom labeling for classes
EntryRelationship represents a relationship between two `DBEntry` instances.
IDFactory provides a way for an application to centralize the creation of new IDs for DBEntry instances
JUserLoginPanel.ImageLocation
Keyword implements a Group/Tag solely based on a String that also represents the ID for the `DBEntry` it is.
LockEntry
LockInfo
LoginListener listens to events associated with a UserLoginStore
MutableCategory an extension of a category that allows to set its parent category
NotApplicableDataWarning used to indicate a 'minor' problem with the data that is to be displayed as a warning rather than an exception
PasswordPolicy defines a policy for accepting passwords when changing them
ProcessedFilterOption allows to control whether a processor is run before filtering when using a `WrappedDBClassStore`.
PropertyEntry represents an entity that is specified by various properties that may flexibly change.
PropertyEntryImpl This class represents a default PropertyEntry implementation that can serve as a base class for PropertyEntry implementations.
ProtocolNote a protocol note.
SortedGroupable same as a Groupable, except this one also supports a stable order of groups, meaning the groups are prioritized.
SpecialRelationship a relationship definition specifying the classes that may be connected as well as the type of relation
Stub a Stub is a small object that can serve as a proxy for larger objects, so that you can maintain a lot of these in memory and only access the full object if needed.
Tag represents a group that allows `Taggable` objects to be a member of.
Taggable represents an object that can be a member of several groups
TransactionCounter A TransactionCounter increments its counter upon transaction begin to allow determining whether it's still the same transaction.
TransactionException thrown to indicate that the caller doesn't hold the lock on an active DBTransaction while trying to access Resources of the associated Database.
TransactionListener listens for DBTransaction changes and can potentially intervene upon preparing for a commit.
TransactionListener.Adapter provides convenient empty implementations for all methods
TransactionRequired This annotation suggests that implementations of these methods (or all methods of that type) should always be called only in a proper transactional context.
User This interface defines the basic functionality for a user; setter methods are optional in the sense that they may generally throw an UnsupportedOperationException
UserFilter a simple user filter that conveniently allows to define acceptance based on rights
UserImpl This class represents a default User implementation that can serve as the basis for more specific implementations.
UserLoginStore defines the ability to manage a system that allows Users to log in/out
WrappedDBClassStore a generic DBClassStore wrapper easing the implementation of special wrappers.
WrongDataException WrongDataException signals a consistency problem with the data submitted to the database.

Classes in com.antelmann.db used by com.antelmann.db.remote
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseChangeListener listens for committed changes through DBClassStore objects in a database and propagates the information to its listeners.
DBClassStore.DBMethod
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBReference DBReference represents an Object that can hold a reference to a DBEntry object, providing sufficient means to retrieve that object from a Database.
DBUpdateEvent
DefaultDBReference this class implements a simple DBReference object.
User This interface defines the basic functionality for a user; setter methods are optional in the sense that they may generally throw an UnsupportedOperationException

Classes in com.antelmann.db used by com.antelmann.genealogy
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBReference DBReference represents an Object that can hold a reference to a DBEntry object, providing sufficient means to retrieve that object from a Database.
DefaultEntryRelationship a default implementation for an EntryRelationship
DefaultSpecialRelationship provides a default implementation for SpecialRelationships.
EntryHeader serves as a reference to a more complex DBEntry object while allowing for more content than a mere Stub.
EntryRelationship represents a relationship between two `DBEntry` instances.
Keyword implements a Group/Tag solely based on a String that also represents the ID for the `DBEntry` it is.
PropertyEntry represents an entity that is specified by various properties that may flexibly change.
PropertyEntryImpl This class represents a default PropertyEntry implementation that can serve as a base class for PropertyEntry implementations.
ProtocolNote a protocol note.
ProtocolNoteEntry
SpecialRelationship a relationship definition specifying the classes that may be connected as well as the type of relation
Stub a Stub is a small object that can serve as a proxy for larger objects, so that you can maintain a lot of these in memory and only access the full object if needed.
Tag represents a group that allows `Taggable` objects to be a member of.
Taggable represents an object that can be a member of several groups
User This interface defines the basic functionality for a user; setter methods are optional in the sense that they may generally throw an UnsupportedOperationException
UserImpl This class represents a default User implementation that can serve as the basis for more specific implementations.

Classes in com.antelmann.db used by com.antelmann.genealogy.db
AbstractDatabase a base class for implementing a database.
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
IDFactory provides a way for an application to centralize the creation of new IDs for DBEntry instances
LoginListener listens to events associated with a UserLoginStore
ProcessedFilterOption allows to control whether a processor is run before filtering when using a `WrappedDBClassStore`.
SessionIdGenerator This class provides efficient unique String-based IDs for different clients.
TransactionRequired This annotation suggests that implementations of these methods (or all methods of that type) should always be called only in a proper transactional context.
WrappedDBClassStore a generic DBClassStore wrapper easing the implementation of special wrappers.

Classes in com.antelmann.db used by com.antelmann.image
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBReference DBReference represents an Object that can hold a reference to a DBEntry object, providing sufficient means to retrieve that object from a Database.
DBTransaction a transaction controlls access to all resources of a Database through DBClassStore instances.
DocumentEntry specifies a general-purpose document that can be managed in a database
EntryHeader serves as a reference to a more complex DBEntry object while allowing for more content than a mere Stub.
IDFactory provides a way for an application to centralize the creation of new IDs for DBEntry instances
Keyword implements a Group/Tag solely based on a String that also represents the ID for the `DBEntry` it is.
ProcessedFilterOption allows to control whether a processor is run before filtering when using a `WrappedDBClassStore`.
PropertyEntry represents an entity that is specified by various properties that may flexibly change.
PropertyEntryImpl This class represents a default PropertyEntry implementation that can serve as a base class for PropertyEntry implementations.
Tag represents a group that allows `Taggable` objects to be a member of.
Taggable represents an object that can be a member of several groups
TransactionRequired This annotation suggests that implementations of these methods (or all methods of that type) should always be called only in a proper transactional context.
WrappedDBClassStore a generic DBClassStore wrapper easing the implementation of special wrappers.
WrongDataException WrongDataException signals a consistency problem with the data submitted to the database.

Classes in com.antelmann.db used by com.antelmann.io
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBEnumeration a special Enumeration that allows to release its resources even though a caller has not completely iterated through this instance.
DBTransaction a transaction controlls access to all resources of a Database through DBClassStore instances.
Stub a Stub is a small object that can serve as a proxy for larger objects, so that you can maintain a lot of these in memory and only access the full object if needed.
TransactionRequired This annotation suggests that implementations of these methods (or all methods of that type) should always be called only in a proper transactional context.

Classes in com.antelmann.db used by com.antelmann.math
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.

Classes in com.antelmann.db used by com.antelmann.net.mail
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
IDFactory provides a way for an application to centralize the creation of new IDs for DBEntry instances
TransactionRequired This annotation suggests that implementations of these methods (or all methods of that type) should always be called only in a proper transactional context.
WrongDataException WrongDataException signals a consistency problem with the data submitted to the database.

Classes in com.antelmann.db used by com.antelmann.net.web
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.

Classes in com.antelmann.db used by com.antelmann.opengeodb
AbstractDatabase a base class for implementing a database.
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
Category represents a category that may be associated with any kind of entry and supports cascading sub-categories
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
LoginListener listens to events associated with a UserLoginStore
Stub a Stub is a small object that can serve as a proxy for larger objects, so that you can maintain a lot of these in memory and only access the full object if needed.

Classes in com.antelmann.db used by com.antelmann.servlet
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBReference DBReference represents an Object that can hold a reference to a DBEntry object, providing sufficient means to retrieve that object from a Database.
EntryClassMapper this interface maps between DBEntry classes and some Object that allows its external storage and retrieval and custom labeling for classes
User This interface defines the basic functionality for a user; setter methods are optional in the sense that they may generally throw an UnsupportedOperationException
UserLoginStore defines the ability to manage a system that allows Users to log in/out

Classes in com.antelmann.db used by com.antelmann.sql
AbstractDatabase a base class for implementing a database.
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
AbstractDBTransaction a simple base implementation for a DBTransaction.
AbstractUserLoginStore a base for easily implementing a UserLoginStore.
BaseDocument a base implementation for a DocumentEntry
Category represents a category that may be associated with any kind of entry and supports cascading sub-categories
Category.Entry
CategoryManager specifies the functionality commonly used to deal with categories and implemented by a `DBClassStore`.
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
DBConfigListener listens to events that change the configuration of the database
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBEnumeration a special Enumeration that allows to release its resources even though a caller has not completely iterated through this instance.
DBReference DBReference represents an Object that can hold a reference to a DBEntry object, providing sufficient means to retrieve that object from a Database.
DBTransaction a transaction controlls access to all resources of a Database through DBClassStore instances.
DefaultDBReference this class implements a simple DBReference object.
DefaultEntryRelationship a default implementation for an EntryRelationship
DocumentEntry specifies a general-purpose document that can be managed in a database
EntryClassMapper this interface maps between DBEntry classes and some Object that allows its external storage and retrieval and custom labeling for classes
EntryClassMapper.Adapter a default implementation (based on some other basic mapping like `EntryClassMapper.STRING_MAPPER`) which supports label customization per instance
EntryHeader serves as a reference to a more complex DBEntry object while allowing for more content than a mere Stub.
IDFactory provides a way for an application to centralize the creation of new IDs for DBEntry instances
Keyword implements a Group/Tag solely based on a String that also represents the ID for the `DBEntry` it is.
LoginListener listens to events associated with a UserLoginStore
ProcessedFilterOption allows to control whether a processor is run before filtering when using a `WrappedDBClassStore`.
PropertyEntry represents an entity that is specified by various properties that may flexibly change.
PropertyEntryFactory a factory for generating PropertyEntry instances
PropertyEntryImpl This class represents a default PropertyEntry implementation that can serve as a base class for PropertyEntry implementations.
SortedGroupable same as a Groupable, except this one also supports a stable order of groups, meaning the groups are prioritized.
Stub a Stub is a small object that can serve as a proxy for larger objects, so that you can maintain a lot of these in memory and only access the full object if needed.
Taggable represents an object that can be a member of several groups
TransactionalNumberGenerator provides a wrapper around a given number generator that provides a counter that can increment and cache its generated values within a running transaction without having to make the potentially expensive call to the embedded ValueRetriever.
TransactionCounter A TransactionCounter increments its counter upon transaction begin to allow determining whether it's still the same transaction.
TransactionException thrown to indicate that the caller doesn't hold the lock on an active DBTransaction while trying to access Resources of the associated Database.
TransactionRequired This annotation suggests that implementations of these methods (or all methods of that type) should always be called only in a proper transactional context.
User This interface defines the basic functionality for a user; setter methods are optional in the sense that they may generally throw an UnsupportedOperationException
UserImpl This class represents a default User implementation that can serve as the basis for more specific implementations.
UserLoginStore defines the ability to manage a system that allows Users to log in/out
WrappedDBClassStore a generic DBClassStore wrapper easing the implementation of special wrappers.
WrongDataException WrongDataException signals a consistency problem with the data submitted to the database.

Classes in com.antelmann.db used by com.antelmann.util
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBEnumeration a special Enumeration that allows to release its resources even though a caller has not completely iterated through this instance.
Stub a Stub is a small object that can serve as a proxy for larger objects, so that you can maintain a lot of these in memory and only access the full object if needed.
TransactionRequired This annotation suggests that implementations of these methods (or all methods of that type) should always be called only in a proper transactional context.

Classes in com.antelmann.db used by com.antelmann.util.gui
Category represents a category that may be associated with any kind of entry and supports cascading sub-categories
CategoryManager specifies the functionality commonly used to deal with categories and implemented by a `DBClassStore`.
Database provides a wrapper around a database service implementation and a lookup service for persistence services for DBEntry objects.
DatabaseException DatabaseException signals problems while accessing/using any form of database.
DBClassStore provides persistence service for a DBEntry class in the context of a Database.
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
DBReference DBReference represents an Object that can hold a reference to a DBEntry object, providing sufficient means to retrieve that object from a Database.
Keyword implements a Group/Tag solely based on a String that also represents the ID for the `DBEntry` it is.
PropertyEntry represents an entity that is specified by various properties that may flexibly change.
Stub a Stub is a small object that can serve as a proxy for larger objects, so that you can maintain a lot of these in memory and only access the full object if needed.
Taggable represents an object that can be a member of several groups
User This interface defines the basic functionality for a user; setter methods are optional in the sense that they may generally throw an UnsupportedOperationException

Classes in com.antelmann.db used by com.antelmann.util.revision
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.

Classes in com.antelmann.db used by com.antelmann.webdav
AbstractDBEntry implements common functionality, including immutable ID and hashCode/equals methods based on the ID (and class).
DBEntry represents a managable resource that can be persisted through database services and accessed by its ID, which is to remain unique even after serialization within other JVMs.
Keyword implements a Group/Tag solely based on a String that also represents the ID for the `DBEntry` it is.

(c) Holger Antelmann since 2001- all rights reserved (contact: info@antelmann.com)
see www.antelmann.com/developer for further details and available downloads