JDBCRowStore (Antelmann.com Java Packages)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Holger's
Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.antelmann.sql
Class JDBCRowStore<T extends DBEntry>

java.lang.Object
  com.antelmann.sql.JDBCRowStore<T>

All Implemented Interfaces:: DBClassStore<T>, TransactionRequired, MappingInfo, ProcessorHook<T,DatabaseException>

Direct Known Subclasses:: DetailRowStore, GenericPropertyEntryStore, RelationshipStore, UserImplStore

public class JDBCRowStore<T extends DBEntry>
extends Object
implements DBClassStore<T>, MappingInfo, ProcessorHook<T,DatabaseException>
extends Object
implements DBClassStore<T>, MappingInfo, ProcessorHook<T,DatabaseException>

provides JDBC persistence for Objects that have a corresponding ObjectRowMapper. Note that this class should not be used by itself, but always through a Proxy wrapped by a SQLDatabase, so that all methods are properly synchronized via the transaction.

Author:: Holger Antelmann
See Also:: SQLDatabase, BaseRowMapper

Nested Class Summary

Nested classes/interfaces inherited from interface com.antelmann.db.DBClassStore
`DBClassStore.DBMethod`

Field Summary
`protected Database<Connection>`	`database`
`protected boolean`	`ensureTransactionsOnFetch` when set to true, the fetch-methods ensure a synchronized transactional context; false is the default
`protected ConnectionHelper`	`helper`
`protected ObjectRowMapper<T>`	`mapper`

Constructor Summary
`JDBCRowStore(Database<Connection> database, ObjectRowMapper<T> mapper, Class<T> typeClass)` typeClass is used to specify the original class for the Stub objects
`JDBCRowStore(Database<Connection> database, ObjectRowMapper<T> mapper, Class<T> typeClass, boolean ignoreInvalidProperties)`
`JDBCRowStore(Database<Connection> database, ObjectRowMapper<T> mapper, Class<T> typeClass, boolean ignoreInvalidProperties, boolean fastDelete)`

Method Summary
`void`	`add(Processor<T,? extends DatabaseException> processor)`
`protected void`	`checkTransaction()` throws the exception if there is no active transaction
`boolean`	`containsID(Object id)` determines whether the given ID is present in this store.
`int`	`deleteEntries(Filter<? super T> filter)` supports SQLMapFilter for more effective deletion.
`boolean`	`deleteEntry(Object id)` removes the entry with the given ID from this store in the database.
`DBEnumeration<T>`	`fetch(Filter<? super T> filter)` Depending of the capabilities of the mapper in use, this method can support various special filters.
`DBEnumeration<Stub<T>>`	`fetchStubs(Filter<? super Stub<?>> filter)` This implementation supports SQLStubFilter and SQLDirectQueryEntryFilter objects; but otherwise, it doesn't filter in any more intelligent way than leaving the filtering to the AbstractIterator.
`Object`	`generateNewID()` returns a value supplied by the mapper
`String[]`	`getColumnNames()` returns all the columns that are retrieved by the mapper when querying the database); the column names for the ID column and display column are included in the returned array.
`String[]`	`getColumnsForTopic(Object topic)` allows to determine whether there are any columns that are applicable for the given topic
`int`	`getColumnSize(String column)` allows to determine the size of the given column name.
`Database<Connection>`	`getDatabase()` provides access to the database instance that also coordinates the transaction management.
`String`	`getDisplayColumn()` for use in stubs (in case a single column is used as a display value)
`String`	`getDisplayNameForColumn(String column)` returns a name suitable for display in a GUI if different from the column name used in the database
`T`	`getEntry(Object id)` returns the DBEntry based on its ID.
`Class<T>`	`getEntryClass()` returns the runtime class type this store represents
`String`	`getIDColumn()` specifies the column where the ID of the entry is mapped to
`ObjectRowMapper<T>`	`getMapper()`
`String`	`getMappingForTopic(Object topic)` allows to determine whether a specific given topic maps to a distinct table, query or column name.
`int`	`getSQLTypeforColumn(String column)` allows to determine the SQL-type for a given column name
`Stub<T>`	`getStub(Object id)` returns a Stub representing the resource for the given ID or null.
`String`	`getTableName()` provides the name of the table that stores the data for the store
`String`	`getTableQuery()` if querying involves something different than just selecting all columns of the table, this method returns the string used to replace the table name in a query.
`void`	`insert(T entry)` it is suggested to create the entry with an ID obtained through `generateNewID()` before passing it into this method.
`Object`	`insertAsNew(T entry)` inserts the given entry using an ID generated by `generateNewID` while ignoring the ID of the given entry.
`boolean`	`isFastDelete()` if set to true, the method deleteResources(Filter) will - in case of a PropertyEntryFilter or a SQLMapFilter - delete the affected rows directly via ConnectionHelper - disregarding what the mapper may define.
`boolean`	`isIgnoreInvalidProperties()`
`boolean`	`remove(Processor<T,? extends DatabaseException> processor)`
`JDBCRowStore<T>`	`setFastDelete(boolean fastDelete)` allows to set a flag that enables this implementation to directly delete on the JDBC level - if applicable.
`void`	`setIgnoreInvalidProperties(boolean ignoreInvalidProperties)`
`int`	`size(Filter<? super T> filter)` supports special performance optimization for SQLMapFilter and some other.
`static String`	`trimIdString(String idColumn)` allows to strip the table name from the column name for cases where the id column needed to be specified as [table].
`void`	`update(T entry)` updates the given entry in the database.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

database

protected Database<Connection> database

helper

protected ConnectionHelper helper

mapper

protected ObjectRowMapper<T extends DBEntry> mapper

ensureTransactionsOnFetch

protected boolean ensureTransactionsOnFetch

when set to true, the fetch-methods ensure a synchronized transactional context; false is the default

See Also:: DBUtils.ensureActive(com.antelmann.db.DBTransaction), AbstractDatabase.setEnsureTransactions(boolean)

Constructor Detail

JDBCRowStore

public JDBCRowStore(Database<Connection> database,
                    ObjectRowMapper<T> mapper,
                    Class<T> typeClass)

typeClass is used to specify the original class for the Stub objects

JDBCRowStore

public JDBCRowStore(Database<Connection> database,
                    ObjectRowMapper<T> mapper,
                    Class<T> typeClass,
                    boolean ignoreInvalidProperties)

JDBCRowStore

public JDBCRowStore(Database<Connection> database,
                    ObjectRowMapper<T> mapper,
                    Class<T> typeClass,
                    boolean ignoreInvalidProperties,
                    boolean fastDelete)

Method Detail

getDatabase

public Database<Connection> getDatabase()

Description copied from interface: DBClassStore

provides access to the database instance that also coordinates the transaction management.

Specified by:: getDatabase in interface DBClassStore<T extends DBEntry>

getEntryClass

public Class<T> getEntryClass()

Description copied from interface: DBClassStore

returns the runtime class type this store represents

Specified by:: getEntryClass in interface DBClassStore<T extends DBEntry>