UncommittedRow (sormula)

java.lang.Object
- org.sormula.cache.UncommittedRow<R>

Type Parameters:

R - cached row type

Direct Known Subclasses:

UncommittedReadOnlyRow, UncommittedWritableRow
```
public abstract class UncommittedRow<R>
extends java.lang.Object
```
Abstract base class for all uncommitted rows in an AbstractCache. Contains a key used to store uncommitted row in cache and a reference to the corresponding row object for that key.

Since:

3.0

Author:

Jeff Miller

Constructor Summary

Constructors
Constructor and Description

UncommittedRow(CacheKey cacheKey, R row)
Constructs for a key and correspond row.

Constructors
Constructor and Description
`UncommittedRow(CacheKey cacheKey, R row)` Constructs for a key and correspond row.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract UncommittedRow<R>`	`delete(R row)` Performs a delete of new row on existing uncommitted row.
`abstract UncommittedRow<R>`	`deleted(R row)` Notifies cache that row has been deleted from database.
`CacheKey`	`getCacheKey()` Gets the cache key for uncommitted row.
`R`	`getRow()` Gets the row associated with this uncommitted row.
`abstract UncommittedRow<R>`	`insert(R row)` Performs an insert of new row on existing uncommitted row.
`abstract UncommittedRow<R>`	`inserted(R row)` Notifies cache that row has been inserted into database.
`abstract UncommittedRow<R>`	`save(R row)` Performs a save of new row on existing uncommitted row.
`abstract UncommittedRow<R>`	`saved(R row)` Notifies cache that row has been saved in database.
`abstract R`	`select()` Performs a primary key select on the uncommitted row.
`abstract R`	`selected(R row)` Notifies cache that row has been selected from database.
`void`	`setRow(R row)` Sets a replacement row for the existing row in this uncommitted row.
`abstract UncommittedRow<R>`	`update(R row)` Performs an update of new row on existing uncommitted row.
`abstract void`	`updateCommitted(Cache<R> cache)` Put this uncommitted row in committed map of cache.
`abstract UncommittedRow<R>`	`updated(R row)` Notifies cache that row has been updated in database.

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

- Constructor Detail
  - UncommittedRow
```
public UncommittedRow(CacheKey cacheKey,
                      R row)
```
    Constructs for a key and correspond row.
    
    Parameters:
    
    cacheKey - cache key based upon primary keys of row
    
    row - row corresponding to cache key
- Method Detail
  - select
```
public abstract R select()
                  throws CacheException
```
    Performs a primary key select on the uncommitted row. Primary key(s) are not needed since uncommitted row knows the primary key(s).
    
    Returns:
    
    row for primary key(s) or null if uncommitted row represents a deleted row
    
    Throws:
    
    CacheException - if error
  - insert
```
public abstract UncommittedRow<R> insert(R row)
                                  throws CacheException
```
    Performs an insert of new row on existing uncommitted row. Typically this will result in a DuplicateCacheException unless uncommitted row represents a deleted row.
    
    Parameters:
    
    row - row to insert
    
    Returns:
    
    new uncommitted row to replace this or null if no change is required
    
    Throws:
    
    CacheException - if error
  - update
```
public abstract UncommittedRow<R> update(R row)
                                  throws CacheException
```
    Performs an update of new row on existing uncommitted row.
    
    Parameters:
    
    row - row to update
    
    Returns:
    
    new uncommitted row to replace this or null if no change is required
    
    Throws:
    
    CacheException - if error
  - save
```
public abstract UncommittedRow<R> save(R row)
                                throws CacheException
```
    Performs a save of new row on existing uncommitted row.
    
    Parameters:
    
    row - row to save
    
    Returns:
    
    new uncommitted row to replace this or null if no change is required
    
    Throws:
    
    CacheException - if error
    
    Since:
    
    3.4
  - delete
```
public abstract UncommittedRow<R> delete(R row)
                                  throws CacheException
```
    Performs a delete of new row on existing uncommitted row.
    
    Parameters:
    
    row - row to delete
    
    Returns:
    
    new uncommitted row to replace this or null if no change is required
    
    Throws:
    
    CacheException - if error
  - selected
```
public abstract R selected(R row)
                    throws CacheException
```
    Notifies cache that row has been selected from database.
    
    Parameters:
    
    row - row that has been selected
    
    Returns:
    
    cached row if exists or null if row has been deleted
    
    Throws:
    
    CacheException - if error
  - inserted
```
public abstract UncommittedRow<R> inserted(R row)
                                    throws CacheException
```
    Notifies cache that row has been inserted into database.
    
    Parameters:
    
    row - row that has been inserted
    
    Returns:
    
    new uncommitted row to replace this or null if no change is required
    
    Throws:
    
    CacheException - if error
  - updated
```
public abstract UncommittedRow<R> updated(R row)
                                   throws CacheException
```
    Notifies cache that row has been updated in database.
    
    Parameters:
    
    row - row that has been updated
    
    Returns:
    
    new uncommitted row to replace this or null if no change is required
    
    Throws:
    
    CacheException - if error
  - saved
```
public abstract UncommittedRow<R> saved(R row)
                                 throws CacheException
```
    Notifies cache that row has been saved in database.
    
    Parameters:
    
    row - row that has been saved
    
    Returns:
    
    new uncommitted row to replace this or null if no change is required
    
    Throws:
    
    CacheException - if error
    
    Since:
    
    3.4
  - deleted
```
public abstract UncommittedRow<R> deleted(R row)
                                   throws CacheException
```
    Notifies cache that row has been deleted from database.
    
    Parameters:
    
    row - row that has been deleted
    
    Returns:
    
    new uncommitted row to replace this or null if no change is required
    
    Throws:
    
    CacheException - if error
  - updateCommitted
```
public abstract void updateCommitted(Cache<R> cache)
                              throws CacheException
```
    Put this uncommitted row in committed map of cache.
    
    Parameters:
    
    cache - cache to affect
    
    Throws:
    
    CacheException - if error
  - getCacheKey
```
public CacheKey getCacheKey()
```
    Gets the cache key for uncommitted row.
    
    Returns:
    
    key supplied in constructor
  - setRow
```
public void setRow(R row)
```
    Sets a replacement row for the existing row in this uncommitted row. Key must be the same.
    
    Parameters:
    
    row - new row
  - getRow
```
public R getRow()
```
    Gets the row associated with this uncommitted row.
    
    Returns:
    
    row that will be written to database

Class UncommittedRow<R>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UncommittedRow

Method Detail

select

insert

update

save

delete

selected

inserted

updated

saved

deleted

updateCommitted

getCacheKey

setRow

getRow