public final class DirtyShareContext
extends java.lang.Object
This implementation maintains state specific to the current context, in order both to filter information appropriately, and to be able to clean up shared data when the current context's transactions are completed.
DirtyShareManager
,
DefaultDirtyShareManager
Modifier and Type | Field and Description |
---|---|
private java.util.Map<java.lang.String,java.util.Set<java.lang.Long>> |
changes
Map of entity names to sets of IDs inserted/updated by this context
|
private java.util.Set<RecordIdentifier<java.lang.String>> |
deadInserts
Identifiers of records inserted by this context, which deletes have rolled back
|
private java.util.Map<java.lang.String,java.util.Set<java.lang.Long>> |
deletes
Map of entity names to sets of IDs deleted by this context
|
private java.util.Map<RecordIdentifier<java.lang.String>,RecordBuffer> |
earlyInserts
Buffers holding newly created records, which have not yet had all their indices updated
|
private java.util.Set<RecordIdentifier<java.lang.String>> |
inserts
Identifiers of records inserted by this context
|
private DirtyShareManager |
manager
Object which manages dirty reads for the database
|
Constructor and Description |
---|
DirtyShareContext(DirtyShareManager manager)
Constructor which stores a reference to the dirty share manager for the
associated database.
|
Modifier and Type | Method and Description |
---|---|
void |
cleanup()
Clean up all information contributed to the dirty share manager by this context for the current
transaction.
|
void |
delete(java.lang.String entity,
java.lang.Long id,
boolean rollback,
boolean lock)
Mark a record as having been deleted in an uncommitted transaction, or
unmark a record which previously was so marked.
|
void |
deregisterForGlobalEvents(long registerID)
Deregister with a global event clearinghouse an interest in insert,
delete, and update events which affect a particular DMO type.
|
RecordBuffer |
getCreatingBuffer(RecordIdentifier<java.lang.String> ident)
If the specified record is an unvalidated insert created by a buffer local to this context,
get the buffer which created it.
|
Record |
getDirtyDMO(java.lang.String entity,
java.lang.Long id)
Retrieve from the dirty database the record specified by the given
entity and primary key, if it exists, and if it was not put there by the
current context.
|
DirtyInfo |
getDirtyInfo(RecordBuffer buffer,
int index,
int queryType,
HQLBundle bundle,
java.lang.Object[] params,
Record found,
boolean byRowid)
Given certain search criteria and possibly a potential DMO match in the primary database,
report any significant information currently being tracked for uncommitted transactions,
which might override data (or the lack thereof) found in the primary database.
|
GlobalChangeEvent[] |
getGlobalEvents(long registerID,
long lastID)
Retrieve any new events that have been collected by a global event
clearinghouse, representing inserts, deletes, and updates made to
record types for which the caller previously has registered interest.
|
void |
insert(RecordBuffer buffer,
Record dmo,
boolean lock)
Begin tracking a newly inserted record in the dirty database.
|
boolean |
isDirtyDelete(java.lang.String entity,
java.lang.Long id,
boolean ignoreLocal)
Indicate whether the record specified by the given entity and primary key has
been deleted within an uncommitted transaction within a context, optionally
ignoring deletes in the current context.
|
boolean |
isEntityDirty(java.lang.String entity)
Indicate whether there are currently any uncommitted changes (inserts,
updates, or deletes) in the table represented by the given DMO entity
name.
|
boolean |
isTracked(RecordIdentifier<java.lang.String> ident)
Indicate whether the specified record is being tracked as newly inserted
by this context.
|
<T> java.util.List<T> |
list(java.lang.String entity,
java.lang.String fql,
java.lang.Object[] params,
int maxResults,
int startOffset,
boolean readOnly)
Execute an HQL query and return the results as a list.
|
void |
lockAllIndexes(java.lang.String entity,
LockType lockType)
Lock or unlock all indexes associated with the given DMO entity.
|
void |
recordInserted(RecordIdentifier<java.lang.String> id)
Notify this object that a record was inserted into database and should not be tracked any more in
earlyInserts . |
java.lang.Long |
registerForGlobalEvents(java.lang.String entity)
Register with a global event clearinghouse an interest in insert,
delete, and update events which affect the given DMO entity.
|
void |
rollbackInsert(RecordIdentifier<java.lang.String> ident,
boolean lock)
Rollback the insert of a record previously introduced with the
insert(RecordBuffer, Record, boolean) method. |
private void |
trackChange(java.lang.String entity,
java.lang.Long id)
Remember that the record represented by the given entity and primary key
ID has been modified in the current context.
|
void |
update(RecordBuffer buffer,
java.lang.String[] properties,
int[] extIndexes,
BaseDataType[] values,
boolean transientIndexValidated)
Track an update to one or more indexed, DMO properties, as indicated by the
properties , extIndexes and values arguments. |
private final DirtyShareManager manager
private java.util.Set<RecordIdentifier<java.lang.String>> inserts
private java.util.Set<RecordIdentifier<java.lang.String>> deadInserts
private java.util.Map<RecordIdentifier<java.lang.String>,RecordBuffer> earlyInserts
private java.util.Map<java.lang.String,java.util.Set<java.lang.Long>> changes
private java.util.Map<java.lang.String,java.util.Set<java.lang.Long>> deletes
DirtyShareContext(DirtyShareManager manager)
manager
- Dirty share manager for the associated database.public java.lang.Long registerForGlobalEvents(java.lang.String entity)
entity
- DMO entity for which the caller is interested in tracking
change.getGlobalEvents(long, long)
,
deregisterForGlobalEvents(long)
public void deregisterForGlobalEvents(long registerID)
registerID
- A unique identifier for the registrant being deregistered.getGlobalEvents(long, long)
,
registerForGlobalEvents(String)
public GlobalChangeEvent[] getGlobalEvents(long registerID, long lastID) throws EventRegistrationException
registerID
- A unique identifier for an object which has registered interest
in record-changing events.lastID
- A unique identifier representing the last event retrieved by
the caller. If less than 0, it is assumed no events have yet
been retrieved since the caller registered interest in these
events.null
if no
such events have been collected.EventRegistrationException
- if registerID
is invalid or has expired.public void lockAllIndexes(java.lang.String entity, LockType lockType) throws PersistenceException
entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.lockType
- Type of lock to acquire, or NONE
to release
existing locks. NO_WAIT
variants will be treated
as regular, blocking variants.PersistenceException
- if there is an error querying JDBC metadata while retrieving
index information.public void insert(RecordBuffer buffer, Record dmo, boolean lock) throws PersistenceException
This record is removed when the adding context's current transaction is committed or rolled back.
buffer
- Record buffer responsible for the insert.dmo
- Record to be tracked.lock
- true
to acquire write locks to insert the record;
false
to assume write locks are acquired by calling code.PersistenceException
- if there is any database error.public boolean isTracked(RecordIdentifier<java.lang.String> ident)
ident
- Record identifier of the record to be checked.true
if this record is newly inserted by this
context, else false
.public RecordBuffer getCreatingBuffer(RecordIdentifier<java.lang.String> ident)
ident
- Record identifier of the record to be checked.null
if the record is not a locally created,
unvalidated insert.public void rollbackInsert(RecordIdentifier<java.lang.String> ident, boolean lock) throws PersistenceException
insert(RecordBuffer, Record, boolean)
method.ident
- Identifier for the target record, which encapsulates its entity
name and primary key.lock
- true
to acquire write locks;
false
to assume write locks are acquired by
calling code.java.lang.IllegalStateException
- if the record was not inserted in this context during the
current transactionPersistenceException
- if there is any database error.public void recordInserted(RecordIdentifier<java.lang.String> id)
earlyInserts
.id
- The identifier of the record.public void update(RecordBuffer buffer, java.lang.String[] properties, int[] extIndexes, BaseDataType[] values, boolean transientIndexValidated) throws PersistenceException
properties
, extIndexes
and values
arguments.
Any record added to the dirty database as a result of this method is removed when the adding context's current transaction is committed or rolled back.
Assumes appropriate indexes have been locked by the caller.
buffer
- Record buffer responsible for the update.properties
- Array of names of those DMO properties which were updated. These should represent
columns which participate in one or more indexes.extIndexes
- In case of EXTENT fields this array contains their index. Otherwise -1.values
- Updated DMO property values. Each value in the array corresponds positionally with
its matching property name in the properties
array.transientIndexValidated
- true
if the update was caused by an index validation of a transient record.PersistenceException
- if there is any database error.public void delete(java.lang.String entity, java.lang.Long id, boolean rollback, boolean lock) throws PersistenceException
If marking a record as deleted, that was earlier inserted by the current context, rollback the insert, but do not mark the record as deleted.
A record is unmarked when the adding context's current transaction is committed or rolled back.
entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.id
- Primary key of deleted record.rollback
- If false
, the target record is marked as deleted;
if true
, it is unmarked.lock
- true
to acquire write locks to delete the record;
false
to assume write locks are acquired by
calling code.PersistenceException
- if a database error occurs rolling back an earlier insert.public boolean isEntityDirty(java.lang.String entity)
entity
- Fully qualified name of the DMO entity to be checked.true
if there any pending, uncommitted changes in
the backing table, else false
.public boolean isDirtyDelete(java.lang.String entity, java.lang.Long id, boolean ignoreLocal)
entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.id
- Primary key of the record to be checked.ignoreLocal
- Ignore a delete if it occurred in the current context and only report
whether a delete of the given record occurred in a different context.true
if the specified record has been deleted, else false
.public Record getDirtyDMO(java.lang.String entity, java.lang.Long id) throws PersistenceException
entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.id
- Primary key of the record to be retrieved.null
.PersistenceException
- if there is any database error.public <T> java.util.List<T> list(java.lang.String entity, java.lang.String fql, java.lang.Object[] params, int maxResults, int startOffset, boolean readOnly) throws PersistenceException
Object
s.
No locking is attempted.
entity
- Name of an entity, which is the name of the DMO implementation class associated
with a table being tracked for uncommitted changes. Should be null
for a multi-table query.fql
- FQL query statement. This method makes no assumptions as to the types of object(s) returned.params
- Substitution values for the query. If none, this should be an empty array.maxResults
- The maximum number of elements to be returned in the list. If this value is
non-positive, no upper limit is applied.startOffset
- The 0-based offset of the first record to retrieve. If this value is non-positive,
an offset of 0 is used by default.readOnly
- true
to execute the query in read-only mode, else false
.null
if no result was found.PersistenceException
- if there was an error executing the query.public DirtyInfo getDirtyInfo(RecordBuffer buffer, int index, int queryType, HQLBundle bundle, java.lang.Object[] params, Record found, boolean byRowid) throws PersistenceException
If a DirtyInfo
object is returned by this method, it will contain overriding
information, such as a dirty DMO which matched the search criteria, whether that record was
newly inserted, or the fact that the candidate record found in the primary search has been
deleted or modified in an uncommitted transaction. A null
return indicates no
overriding information was available.
buffer
- Record buffer associated with the current query.index
- UID of index which governs the ordering of data in the current query.queryType
- Type of query.bundle
- An object containing one or more FQL statements to be executed against the dirty
database to find a record which matches the current query criteria. The list is in
order of most specific to least specific search criteria.params
- Query substitution parameters which match placeholders in the most specific FQL
statement.found
- DMO, if any, found in the primary database, which matches the current query criteria.byRowid
- The predicate of the query does a lookup for ROWID/RECID of the table. In case of
transient records they are accessible without the need of having a full matched
index.null
if no uncommitted change
information was available for the given arguments.PersistenceException
- if there is any database error.public void cleanup()
StopConditionException
- if a critical database error occurs that would leave the dirty database in an improper state.private void trackChange(java.lang.String entity, java.lang.Long id)
entity
- Name of an entity, which is the name of the DMO implementation
class associated with a table being tracked for uncommitted
changes.id
- Primary key ID of the modified record.