PartialStash (stallion-core 1.0.0-SNAPSHOT API)

java.lang.Object
- io.stallion.dataAccess.Stash<T>
- - io.stallion.dataAccess.PartialStash<T>

Type Parameters:

T -

Direct Known Subclasses:

UserPartialStash
```
public class PartialStash<T extends Model>
extends Stash<T>
```
PartialStash loads the most recently updated 50,000 items in memory, and also keeps in memory every item directly loaded by id. This is useful for largish tables with recent data accessed very frequently, but where you don't want to incur a really long load-time when booting the server during deployment.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Col>`	`columns`
`protected Map<Long,T>`	`itemByPrimaryKey`
`protected List<T>`	`items`
`protected Map<String,Map<Object,T>>`	`keyNameToUniqueKeyToValue`
`protected Set<String>`	`uniqueFields`

Constructor Summary

Constructors
Constructor and Description

PartialStash()

Constructors
Constructor and Description
`PartialStash()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cloneInto(Object source, Object dest, Iterable<String> properties, Boolean copyNulls, List<String> changedKeyFields)` Clones all non-null values from "source" into "dest"
`int`	`countForKey(String keyName, Object value)` Count the number of objects associated with an alternative key
`T`	`detach(T obj)` Return a cloned version of the object.
`FilterChain<T>`	`filterByKey(String key, Object lookupValue)` Create a new filterChain, restricting it to items matching the lookupValue for the key
`FilterChain<T>`	`filterChain()` Create a new FilterChain for this stash
`FilterChain<T>`	`filterChain(List<T> subset)` Create a new filter chain using a subset of items
`T`	`forId(Long id)` Get a cloned/detached object by id
`T`	`forUniqueKey(String keyName, Object lookupValue)` Retrieve an object via unique key.
`String`	`getInitialLoadSql()`
`List<T>`	`getItems()` All the items in the stash.
`void`	`hardDelete(T obj)` Remove the object from the stash and the underlying data store
`void`	`init(DataAccessRegistration registration, ModelController<T> controller, Persister<T> persister)` Initialized the Stash with required attributes, this is called via dataAccess registration.
`List<T>`	`listForKey(String keyName, Object value)` Retrieve all objects for a given alternative key
`void`	`loadAll()` Load all items from the datastore into the stash.
`void`	`loadForId(Long id)` Load or reload the item with the given id from the datastore into the stash
`boolean`	`loadItem(T item)` Re-load the given object from the datastore into the stash
`void`	`onPreRead()` Called before any of the data access methods run
`T`	`originalForId(Long id)` Get the original object by id, if modified, the object in the stash will be modified, so be careful.
`protected void`	`preRegisterItem(T item)` This gets called before persist, to avoid a race-condition whereby: 1) Thread A saves to the database 2) Thread B syncs from the database and loads the new object 3) Thread A finishes the database save, and then adds the newly saved item to the registry 4) Now we have two copies of the object in memory
`protected void`	`registerItem(T item)`
`void`	`registerKeys(T item)`
`void`	`reset()` Reset the cache, nulling out all existing fields, and then reloading everything from the database.
`void`	`save(T obj)` Save the object to the stash and the underlying data store
`void`	`sync(T obj)` Take the passed in object, find the object in the stash with the same id, and sync the data of the passed in object to the stashed object.
`void`	`syncForSave(T obj)`

Methods inherited from class io.stallion.dataAccess.Stash
getBucket, getController, getKeyFields, getPersister, getUniqueFields, reloadIfNewer, setKeyFields, setUniqueFields

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

- Field Detail
  - itemByPrimaryKey
```
protected Map<Long,T extends Model> itemByPrimaryKey
```
  - items
```
protected List<T extends Model> items
```
  - uniqueFields
```
protected Set<String> uniqueFields
```
  - keyNameToUniqueKeyToValue
```
protected Map<String,Map<Object,T extends Model>> keyNameToUniqueKeyToValue
```
  - columns
```
protected List<Col> columns
```
- Constructor Detail
  - PartialStash
```
public PartialStash()
```
- Method Detail
  - init
```
public void init(DataAccessRegistration registration,
                 ModelController<T> controller,
                 Persister<T> persister)
```
    Description copied from class: Stash
    
    Initialized the Stash with required attributes, this is called via dataAccess registration.
    
    Overrides:
    
    init in class Stash<T extends Model>
  - sync
```
public void sync(T obj)
```
    Description copied from class: Stash
    
    Take the passed in object, find the object in the stash with the same id, and sync the data of the passed in object to the stashed object. This is used when saving a detached object -- first you have to sync the changes to the stashed version of the object, then persist it. By default, sync will not sync builtin or internal fields
    
    Specified by:
    
    sync in class Stash<T extends Model>
  - cloneInto
```
public boolean cloneInto(Object source,
                         Object dest,
                         Iterable<String> properties,
                         Boolean copyNulls,
                         List<String> changedKeyFields)
```
    Clones all non-null values from "source" into "dest"
    
    Parameters:
    
    source -
    
    dest -
    
    properties -
    
    copyNulls -
    
    changedKeyFields -
  - detach
```
public T detach(T obj)
```
    Description copied from class: Stash
    
    Return a cloned version of the object.
    
    Specified by:
    
    detach in class Stash<T extends Model>
    
    Returns:
  - save
```
public void save(T obj)
```
    Description copied from class: Stash
    
    Save the object to the stash and the underlying data store
    
    Specified by:
    
    save in class Stash<T extends Model>
  - syncForSave
```
public void syncForSave(T obj)
```
    Overrides:
    
    syncForSave in class Stash<T extends Model>
  - hardDelete
```
public void hardDelete(T obj)
```
    Description copied from class: Stash
    
    Remove the object from the stash and the underlying data store
    
    Specified by:
    
    hardDelete in class Stash<T extends Model>
  - loadAll
```
public void loadAll()
```
    Description copied from class: Stash
    
    Load all items from the datastore into the stash.
    
    Specified by:
    
    loadAll in class Stash<T extends Model>
  - getInitialLoadSql
```
public String getInitialLoadSql()
```
  - loadForId
```
public void loadForId(Long id)
```
    Description copied from class: Stash
    
    Load or reload the item with the given id from the datastore into the stash
    
    Specified by:
    
    loadForId in class Stash<T extends Model>
  - loadItem
```
public boolean loadItem(T item)
```
    Description copied from class: Stash
    
    Re-load the given object from the datastore into the stash
    
    Specified by:
    
    loadItem in class Stash<T extends Model>
  - preRegisterItem
```
protected void preRegisterItem(T item)
```
    This gets called before persist, to avoid a race-condition whereby: 1) Thread A saves to the database 2) Thread B syncs from the database and loads the new object 3) Thread A finishes the database save, and then adds the newly saved item to the registry 4) Now we have two copies of the object in memory
    
    Parameters:
    
    item -
  - registerItem
```
protected void registerItem(T item)
```
  - registerKeys
```
public void registerKeys(T item)
```
  - getItems
```
public List<T> getItems()
```
    Description copied from class: Stash
    
    All the items in the stash.
    
    Specified by:
    
    getItems in class Stash<T extends Model>
    
    Returns:
  - reset
```
public void reset()
```
    Description copied from class: Stash
    
    Reset the cache, nulling out all existing fields, and then reloading everything from the database.
    
    Specified by:
    
    reset in class Stash<T extends Model>
  - onPreRead
```
public void onPreRead()
```
    Description copied from class: Stash
    
    Called before any of the data access methods run
    
    Specified by:
    
    onPreRead in class Stash<T extends Model>
  - forId
```
public T forId(Long id)
```
    Description copied from class: Stash
    
    Get a cloned/detached object by id
    
    Specified by:
    
    forId in class Stash<T extends Model>
    
    Returns:
  - originalForId
```
public T originalForId(Long id)
```
    Description copied from class: Stash
    
    Get the original object by id, if modified, the object in the stash will be modified, so be careful.
    
    Specified by:
    
    originalForId in class Stash<T extends Model>
    
    Returns:
  - forUniqueKey
```
public T forUniqueKey(String keyName,
                      Object lookupValue)
```
    Description copied from class: Stash
    
    Retrieve an object via unique key.
    
    Specified by:
    
    forUniqueKey in class Stash<T extends Model>
    
    Returns:
  - listForKey
```
public List<T> listForKey(String keyName,
                          Object value)
```
    Description copied from class: Stash
    
    Retrieve all objects for a given alternative key
    
    Specified by:
    
    listForKey in class Stash<T extends Model>
    
    Returns:
  - countForKey
```
public int countForKey(String keyName,
                       Object value)
```
    Description copied from class: Stash
    
    Count the number of objects associated with an alternative key
    
    Specified by:
    
    countForKey in class Stash<T extends Model>
    
    Returns:
  - filterChain
```
public FilterChain<T> filterChain()
```
    Description copied from class: Stash
    
    Create a new FilterChain for this stash
    
    Specified by:
    
    filterChain in class Stash<T extends Model>
    
    Returns:
  - filterByKey
```
public FilterChain<T> filterByKey(String key,
                                  Object lookupValue)
```
    Description copied from class: Stash
    
    Create a new filterChain, restricting it to items matching the lookupValue for the key
    
    Specified by:
    
    filterByKey in class Stash<T extends Model>
    
    Parameters:
    
    key - - a model field that has been defined as a key
    
    Returns:
  - filterChain
```
public FilterChain<T> filterChain(List<T> subset)
```
    Description copied from class: Stash
    
    Create a new filter chain using a subset of items
    
    Specified by:
    
    filterChain in class Stash<T extends Model>
    
    Returns:

Class PartialStash<T extends Model>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.stallion.dataAccess.Stash

Methods inherited from class java.lang.Object

Field Detail

itemByPrimaryKey

items

uniqueFields

keyNameToUniqueKeyToValue

columns

Constructor Detail

PartialStash

Method Detail

init

sync

cloneInto

detach

save

syncForSave

hardDelete

loadAll

getInitialLoadSql

loadForId

loadItem

preRegisterItem

registerItem

registerKeys

getItems

reset

onPreRead

forId

originalForId

forUniqueKey

listForKey

countForKey

filterChain

filterByKey

filterChain