Holger's Java API

## Uses of Interface
com.antelmann.db.DBReference

Packages that use DBReference
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.image: This package contains classes for more easily dealing with images.
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.gui: This package contains utility classes for GUI related implementations.

Uses of DBReference in com.antelmann.crm

Methods in com.antelmann.crm with parameters of type DBReference
`R` `RoleManager.getRole(DBReference baseEntry)` returns the first role found of the specified type or `null`
`Collection<R>` `RoleManager.getRoles(DBReference baseEntry)` returns a collection of roles for the given base entry or an empty collection
`boolean` `RoleManager.hasRoles(DBReference baseEntry)` determines whether there are roles of type R for the given base entry

Uses of DBReference in com.antelmann.db

Classes in com.antelmann.db that implement DBReference
`class` `DefaultDBReference` this class implements a simple DBReference object.
`class` `EntryHeader<T extends DBEntry>` serves as a reference to a more complex DBEntry object while allowing for more content than a mere Stub.
`class` `Stub<T extends DBEntry>` 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.

Fields in com.antelmann.db declared as DBReference
`DBReference` `LockInfo.reference`

Methods in com.antelmann.db that return DBReference
`static DBReference` `DBUtils.ensureReferenceString(Database<?> db, DBReference ref)`
`DBReference` `ProtocolNoteEntry.getDocumentReference()`
`DBReference` `ProtocolNote.getDocumentReference()` specifies a reference to the document this protocol note is based on
`DBReference` `EntryRelationship.getFromReference()` represents the first entry of this relationship
`DBReference` `DefaultEntryRelationship.getFromReference()`
`DBReference` `LockEntry.getReference()`
`DBReference` `EntryRelationship.getToReference()` represents the second entry of this relationship
`DBReference` `DefaultEntryRelationship.getToReference()`
`static DBReference` `DefaultDBReference.verify(DBReference ref, Class<?> type)` verifies that the given reference is indeed of the given type
`static DBReference` `DefaultDBReference.verifyBase(DBReference ref, Class<?> baseType)`

Methods in com.antelmann.db that return types with arguments of type DBReference
`static Comparator<DBReference>` `DefaultDBReference.getRefStringComparator()`

Methods in com.antelmann.db with parameters of type DBReference
`boolean` `DBReferenceFilter.accept(DBReference entry)`
`boolean` `AbstractDatabase.contains(DBReference ref)`
`boolean` `AbstractDatabase.delete(DBReference ref)`
`static DBReference` `DBUtils.ensureReferenceString(Database<?> db, DBReference ref)`
`static void` `DefaultDBReference.ensureReferenceString(DBReference ref, Database<?> db)`
`static boolean` `DBUtils.exists(Database<?> db, DBReference ref)` determines whether there is a relevant store that contains the relevant id for the given reference in the given database
`protected String` `DBEntrySelection.extractStringFlavor(DBReference ref)` allows to customize the String used for the `DataFlavor.stringFlavor`; here, `getReferenceString()` is used
`boolean` `LockManager.forceUnlock(DBReference ref, long lockTime)` if you don't have the token, you may first obtain the LockInfo and then use its time to release the given lock
`static DBEntry` `DBUtils.get(Database<?> db, DBReference ref)` determines whether there is a relevant store that contains the relevant id for the given reference in the given database.
`Iterable<Object>` `CategoryManager.getAllSubCategoryIDs(DBReference categoryRef)`
`DBEntry` `AbstractDatabase.getEntry(DBReference ref)` This method will begin and abort a transaction if none is active at the time.
`Filter<LockEntry>` `LockManager.getFilterFor(DBReference ref)` this may want to be overridden to be more efficient based on the mapping in use
`LockInfo` `LockManager.getLockInfo(DBReference ref)`
`Stub<? extends DBEntry>` `AbstractDatabase.getStub(DBReference ref)` This method will begin and abort a transaction if none is active at the time.
`List<? extends Category<?>>` `CategoryManager.getSubCategories(DBReference categoryRef)`
`static boolean` `DefaultDBReference.isAllNull(DBReference ref)`
`static boolean` `DefaultDBReference.isConsistent(DBReference ref)` returns true only if the given reference applies to the rule that all relevant values (reference class and reference id) are both either null or non-null.
`static boolean` `DefaultDBReference.isEmpty(DBReference ref)` if true is returned, this reference may still contain a reference string
`static boolean` `DefaultDBReference.isInstanceof(DBReference ref, Class<?> type)`
`boolean` `CategoryManager.isLeaf(DBReference categoryRef)`
`boolean` `LockManager.isLocked(DBReference ref)`
`boolean` `LockManager.isLockedWithToken(DBReference ref, String token)`
`boolean` `Stub.isSameReference(DBReference ref)`
`static boolean` `Stub.isSameReference(DBReference ref1, DBReference ref2)`
`boolean` `CategoryManager.isUsed(DBReference categoryRef)`
`static Stub<?>` `DBUtils.loadStub(Database<?> db, DBReference ref)` reloads a reference as a stub, so that the display value is properly initialized.
`String` `LockManager.lock(DBReference ref, String who, String where, String why)`
`static Stub<?>` `Stub.makeStub(DBReference ref)` if the given reference is already a stub, the same is returned; null parameter or empty references result in null as a return value

`static

`<T extends DBEntry> Stub<T>`

`

`Stub.makeStub(DBReference ref, Class<T> type)`
combines `Stub.makeStub(DBReference)` and `Stub.castStub(Stub, Class)`

`static boolean` `DBUtils.referenceRefersToEntry(DBReference ref, DBEntry entry)`
`static boolean` `DefaultDBReference.refersTo(DBReference ref, DBEntry entry)`
`boolean` `LockManager.release(DBReference ref, String token)`
`static DBEntry` `DBEntrySelection.resolve(DBReference ref, Database<?> db)`
`boolean` `DefaultDBReference.sameReference(DBReference ref)`
`static boolean` `DefaultDBReference.sameReference(DBReference ref1, DBReference ref2)` determines whether both given references refer to the same entry
`void` `ProtocolNoteEntry.setDocumentReference(DBReference ref)`
`boolean` `LockManager.unlock(DBReference ref, String token)`
`static DBReference` `DefaultDBReference.verify(DBReference ref, Class<?> type)` verifies that the given reference is indeed of the given type
`static DBReference` `DefaultDBReference.verifyBase(DBReference ref, Class<?> baseType)`

Method parameters in com.antelmann.db with type arguments of type DBReference

`static

`<T extends DBEntry> int`

`

`DBUtils.delete(Database<?> db, Iterable<? extends DBReference> list)`
deletes the given entries from the database

`static HashSet<Object>` `DBUtils.getIDSet(Collection<? extends DBReference> col)`

Constructors in com.antelmann.db with parameters of type DBReference
`DBEntrySelection(DBReference... references)`
`DefaultDBReference(DBReference ref)`
`DefaultEntryRelationship(Object id, DBReference fromReference, DBReference toReference, Object type)`
`DefaultEntryRelationship(Object id, DBReference fromReference, DBReference toReference, Object type, boolean bidirectional)`
`LockEntry(Object id, DBReference ref, String who, String where, long when, String why, String token)`

Uses of DBReference in com.antelmann.db.remote

Constructors in com.antelmann.db.remote with parameters of type DBReference
`RemoteDBUpdateEvent.Option(InetAddress computer, DBReference user)`

Uses of DBReference in com.antelmann.genealogy

Classes in com.antelmann.genealogy that implement DBReference
`static class` `GPerson.Header`

Uses of DBReference in com.antelmann.image

Classes in com.antelmann.image that implement DBReference
`static class` `ImageURLEntry.Thumbnail<T extends ImageURLEntry>`

Uses of DBReference in com.antelmann.servlet

Methods in com.antelmann.servlet that return DBReference
`protected DBReference` `DBEntryServlet.makeReference(javax.servlet.http.HttpServletRequest req)`

Uses of DBReference in com.antelmann.sql

Classes in com.antelmann.sql that implement DBReference
`static class` `DBDocument.Header`

Methods in com.antelmann.sql with parameters of type DBReference
`protected void` `BaseRowMapper.checkExistence(DBReference ref)`
`Iterable<Object>` `CategoryStore.getAllSubCategoryIDs(DBReference categoryRef)`
`List<T>` `CategoryStore.getSubCategories(DBReference categoryRef)`
`static Map<Class<? extends DBEntry>,Integer>` `ForeignKeyMappingInfo.Analyzer.getUsage(DBReference ref, Database<?> db)`
`boolean` `RelationshipStore.hasRelationships(DBReference ref)`
`boolean` `RelationshipManager.hasRelationships(DBReference ref)` determines if there are any relationsips present for a given reference (both: active and passive)
`static boolean` `ForeignKeyMappingInfo.Analyzer.isInUse(DBReference ref, Database<?> db)`
`boolean` `CategoryStore.isLeaf(DBReference categoryRef)`
`boolean` `CategoryStore.isUsed(DBReference categoryRef)`
`Set<DefaultEntryRelationship>` `RelationshipStore.listAllRelations(DBReference ref, Object relationType)`
`Set<DefaultEntryRelationship>` `RelationshipManager.listAllRelations(DBReference ref, Object relationType)` contains passive and active relationships for the given reference - restricted to the given type if non-null
`void` `BaseRowMapper.mapReference(DBReference ref, Map<String,Object> map, Object idTopic, Object classTopic, Object stringTopic)` #see `BaseRowMapper.mapReference(DBReference, Map, Object, Object, Object, Class)`
`void` `BaseRowMapper.mapReference(DBReference ref, Map<String,Object> map, Object idTopic, Object classTopic, Object stringTopic, Class<?> refType)` convenience method to map a `DBReference` to the given topics while optionally being able to provide an `EntryClassMapper` If the topic does not exist but is a String that is an existing column, it is used as such.

Uses of DBReference in com.antelmann.util.gui

Methods in com.antelmann.util.gui that return types with arguments of type DBReference

`static

`<T extends DBEntry> ValueRetriever<DBReference>`

`

`MyAbstractAction.createReferenceRetriever(ValueRetriever<T> retriever)`

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