ReadOnlyCache (sormula)

java.lang.Object
- org.sormula.cache.AbstractCache<R>
- - org.sormula.cache.readonly.ReadOnlyCache<R>

Type Parameters:

R - cached row type

All Implemented Interfaces:

Cache<R>
```
public class ReadOnlyCache<R>
extends AbstractCache<R>
```
A cache that retains rows that selected, inserted, updated, and deleted. Rows are never written to the database by the cache. The traditional sormula modify operations perform the updates immediately without caching. The selected and modified rows are retained in cache for life of Table object or until explicitly flushed with Table.flush(), or Database.flush() or evicted with Cache.evict(Object) or Cache.evictAll().
This is a transaction based cache which means that caching is performed relative to database transaction boundaries of begin, commit, and rollback. Tables that are cached may not read/write unless a transaction is active. Tables that are cached must use Transaction obtained from Database.getTransaction() or must use a subclass of Transaction that is set with Database.setTransaction(Transaction).
Cached rows are stored in maps with primary keys as the map key. The primary key is defined by Column.primaryKey(), Column.identity(), or Row.primaryKeyFields(). Cache will be searched when selecting by primary key. Non primary key selects will not use cache.

Since:

3.0

Author:

Jeff Miller

Constructor Summary

Constructors
Constructor and Description

ReadOnlyCache(Table<R> table, Cached cachedAnnotation)
Constructs for a table and cache annotation.

Constructors
Constructor and Description
`ReadOnlyCache(Table<R> table, Cached cachedAnnotation)` Constructs for a table and cache annotation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close(SqlOperation<R> sqlOperation)` Does nothing.
`boolean`	`delete(R row)` Returns false since read only cache never writes to database and is never authority for row.
`void`	`deleted(R row)` Indicates that a row was deleted from database.
`void`	`execute(SqlOperation<R> sqlOperation)` Prepares cache for use.
`boolean`	`insert(R row)` Returns false since read only cache never writes to database and is never authority for row.
`void`	`inserted(R row)` Indicates that a row was inserted into database.
`boolean`	`save(R row)` Returns false since read only cache never writes to database and is never authority for row.
`void`	`saved(R row)` Indicates that a row was saved in database.
`R`	`select(java.lang.Object[] primaryKeys)` Performs an equivalent to SQL select on cache for a row with primary key(s).
`R`	`selected(R row)` Indicates row was selected from database.
`boolean`	`update(R row)` Returns false since read only cache never writes to database and is never authority for row.
`void`	`updated(R row)` Indicates that a row was updated in database.
`void`	`write()` Does nothing.

Methods inherited from class org.sormula.cache.AbstractCache
begin, check, commit, contains, evict, evictAll, getCachedAnnotation, getCommitted, getCommittedCache, getHits, getMisses, getPercentHits, getPrimaryKeyExtractor, getPrimaryKeyValues, getTable, getUncommitted, getUncommittedCache, hit, initCommittedCache, initUncommittedCache, log, miss, putCommitted, putUncommitted, removeCommited, rollback, setCommittedCache, setUncommittedCache, transition

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

- Constructor Detail
  - ReadOnlyCache
```
public ReadOnlyCache(Table<R> table,
                     Cached cachedAnnotation)
              throws CacheException
```
    Constructs for a table and cache annotation.
    
    Parameters:
    
    table - cache rows for this table
    
    cachedAnnotation - cache configuration
    
    Throws:
    
    CacheException - if error
- Method Detail
  - execute
```
public void execute(SqlOperation<R> sqlOperation)
             throws CacheException
```
    Prepares cache for use.
    
    Parameters:
    
    sqlOperation - ignored
    
    Throws:
    
    CacheException - if cache has not been initialized (no transaction is active)
  - close
```
public void close(SqlOperation<R> sqlOperation)
           throws CacheException
```
    Does nothing.
    
    Parameters:
    
    sqlOperation - ignored
    
    Throws:
    
    CacheException - if error
  - select
```
public R select(java.lang.Object[] primaryKeys)
         throws CacheException
```
    Performs an equivalent to SQL select on cache for a row with primary key(s). If false is returned, then invoke Cache.selected(Object) when the row is selected from database. If true is returned, then Cache.selected(Object) must not be invoked.
    
    Parameters:
    
    primaryKeys - primary key(s) for one row
    
    Returns:
    
    row for primary key(s) if row exists in cache; null if row is not in cache or row will be deleted for primary key(s)
    
    Throws:
    
    CacheException - if error
  - insert
```
public boolean insert(R row)
               throws CacheException
```
    Returns false since read only cache never writes to database and is never authority for row.
    
    Parameters:
    
    row - ignored
    
    Returns:
    
    false
    
    Throws:
    
    CacheException - if error
  - update
```
public boolean update(R row)
               throws CacheException
```
    Returns false since read only cache never writes to database and is never authority for row.
    
    Parameters:
    
    row - ignored
    
    Returns:
    
    false
    
    Throws:
    
    CacheException - if error
  - save
```
public boolean save(R row)
             throws CacheException
```
    Returns false since read only cache never writes to database and is never authority for row.
    
    Parameters:
    
    row - ignored
    
    Returns:
    
    false
    
    Throws:
    
    CacheException - if error
    
    Since:
    
    3.4
  - delete
```
public boolean delete(R row)
               throws CacheException
```
    Returns false since read only cache never writes to database and is never authority for row.
    
    Parameters:
    
    row - ignored
    
    Returns:
    
    false
    
    Throws:
    
    CacheException - if error
  - selected
```
public R selected(R row)
           throws CacheException
```
    Indicates row was selected from database. Always use returned row since it will be consistent with what is stored in cache. Row is added to cache if appropriate.
    
    Parameters:
    
    row - that was selected
    
    Returns:
    
    cached row if row parameter if row already exists in cache; null if row has been deleted
    
    Throws:
    
    CacheException - if error
  - inserted
```
public void inserted(R row)
              throws CacheException
```
    Indicates that a row was inserted into database. Row is added to cache if appropriate.
    
    Parameters:
    
    row - that was inserted
    
    Throws:
    
    CacheException - if error
  - updated
```
public void updated(R row)
             throws CacheException
```
    Indicates that a row was updated in database. Row is added to cache if appropriate.
    
    Parameters:
    
    row - that was updated
    
    Throws:
    
    CacheException - if error
  - saved
```
public void saved(R row)
           throws CacheException
```
    Indicates that a row was saved in database. Row is added to cache if appropriate.
    
    Parameters:
    
    row - that was saved
    
    Throws:
    
    CacheException - if error
  - deleted
```
public void deleted(R row)
             throws CacheException
```
    Indicates that a row was deleted from database. Row is added to cache if appropriate.
    
    Parameters:
    
    row - that was deleted
    
    Throws:
    
    CacheException - if error
  - write
```
public void write()
           throws CacheException
```
    Does nothing.
    
    Throws:
    
    CacheException - if error

Class ReadOnlyCache<R>

Constructor Summary

Method Summary

Methods inherited from class org.sormula.cache.AbstractCache

Methods inherited from class java.lang.Object

Constructor Detail

ReadOnlyCache

Method Detail

execute

close

select

insert

update

save

delete

selected

inserted

updated

saved

deleted

write