Stash (stallion-core 1.0.0-SNAPSHOT API)

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

Type Parameters:

T -

Direct Known Subclasses:

PartialStash, StashBase
```
public abstract class Stash<T extends Model>
extends Object
```
The Stash sits between the ModelController and the Persister. ModelController is what is used externally to access the data. The Persister controls the interaction between Stallion and the actual data store, whether that be your file system or database. The Stash can either be a complete pass-through and do nothing at all, or it can actually sync all the objects from the datastore into local memory (using LocalMemoryStash).

Constructor Summary

Constructors
Constructor and Description

Stash()

Constructors
Constructor and Description
`Stash()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract int`	`countForKey(String keyName, Object value)` Count the number of objects associated with an alternative key
`abstract T`	`detach(T obj)` Return a cloned version of the object.
`abstract FilterChain<T>`	`filterByKey(String key, Object lookupValue)` Create a new filterChain, restricting it to items matching the lookupValue for the key
`abstract FilterChain<T>`	`filterChain()` Create a new FilterChain for this stash
`abstract FilterChain<T>`	`filterChain(List<T> subset)` Create a new filter chain using a subset of items
`abstract T`	`forId(Long id)` Get a cloned/detached object by id
`abstract T`	`forUniqueKey(String keyName, Object value)` Retrieve an object via unique key.
`String`	`getBucket()` Get the bucket name
`ModelController<T>`	`getController()` Get the associated controller
`abstract List<T>`	`getItems()` All the items in the stash.
`Set<String>`	`getKeyFields()` Get the fields that have been defined as alternative lookup keys.
`Persister<T>`	`getPersister()` Get the associated persister
`Set<String>`	`getUniqueFields()` Get the field names that have been defined as unique keys.
`abstract 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.
`abstract List<T>`	`listForKey(String keyName, Object value)` Retrieve all objects for a given alternative key
`abstract void`	`loadAll()` Load all items from the datastore into the stash.
`abstract void`	`loadForId(Long id)` Load or reload the item with the given id from the datastore into the stash
`abstract boolean`	`loadItem(T obj)` Re-load the given object from the datastore into the stash
`abstract void`	`onPreRead()` Called before any of the data access methods run
`abstract T`	`originalForId(Long id)` Get the original object by id, if modified, the object in the stash will be modified, so be careful.
`T`	`reloadIfNewer(T obj)` Reload from the underlying datastore if the stashed version is older than the version in the datastore.
`abstract void`	`reset()` Reset the cache, nulling out all existing fields, and then reloading everything from the database.
`abstract void`	`save(T obj)` Save the object to the stash and the underlying data store
`Stash<T>`	`setKeyFields(Set<String> keyFields)`
`Stash<T>`	`setUniqueFields(Set<String> uniqueFields)`
`abstract 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Stash
```
public Stash()
```
- Method Detail
  - init
```
public void init(DataAccessRegistration registration,
                 ModelController<T> controller,
                 Persister<T> persister)
```
    Initialized the Stash with required attributes, this is called via dataAccess registration.
    
    Parameters:
    
    registration -
    
    controller -
    
    persister -
  - getController
```
public ModelController<T> getController()
```
    Get the associated controller
    
    Returns:
  - getPersister
```
public Persister<T> getPersister()
```
    Get the associated persister
    
    Returns:
  - getBucket
```
public String getBucket()
```
    Get the bucket name
    
    Returns:
  - getKeyFields
```
public Set<String> getKeyFields()
```
    Get the fields that have been defined as alternative lookup keys. A LocalMemoryStash will create lookup tables for all these fields, for fast access.
    
    Returns:
  - setKeyFields
```
public Stash<T> setKeyFields(Set<String> keyFields)
```
  - getUniqueFields
```
public Set<String> getUniqueFields()
```
    Get the field names that have been defined as unique keys. A LocalMemoryStash will create lookup tables for all these fields, for fast access.
    
    Returns:
  - setUniqueFields
```
public Stash<T> setUniqueFields(Set<String> uniqueFields)
```
  - sync
```
public abstract 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. 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
    
    Parameters:
    
    obj -
  - syncForSave
```
public void syncForSave(T obj)
```
  - detach
```
public abstract T detach(T obj)
```
    Return a cloned version of the object.
    
    Parameters:
    
    obj -
    
    Returns:
  - save
```
public abstract void save(T obj)
```
    Save the object to the stash and the underlying data store
    
    Parameters:
    
    obj -
  - hardDelete
```
public abstract void hardDelete(T obj)
```
    Remove the object from the stash and the underlying data store
    
    Parameters:
    
    obj -
  - loadAll
```
public abstract void loadAll()
```
    Load all items from the datastore into the stash.
  - loadItem
```
public abstract boolean loadItem(T obj)
```
    Re-load the given object from the datastore into the stash
    
    Parameters:
    
    obj -
  - loadForId
```
public abstract void loadForId(Long id)
```
    Load or reload the item with the given id from the datastore into the stash
    
    Parameters:
    
    id -
  - getItems
```
public abstract List<T> getItems()
```
    All the items in the stash.
    
    Returns:
  - reset
```
public abstract void reset()
```
    Reset the cache, nulling out all existing fields, and then reloading everything from the database.
  - onPreRead
```
public abstract void onPreRead()
```
    Called before any of the data access methods run
  - reloadIfNewer
```
public T reloadIfNewer(T obj)
```
    Reload from the underlying datastore if the stashed version is older than the version in the datastore.
    
    Parameters:
    
    obj -
    
    Returns:
  - forId
```
public abstract T forId(Long id)
```
    Get a cloned/detached object by id
    
    Parameters:
    
    id -
    
    Returns:
  - originalForId
```
public abstract T originalForId(Long id)
```
    Get the original object by id, if modified, the object in the stash will be modified, so be careful.
    
    Parameters:
    
    id -
    
    Returns:
  - forUniqueKey
```
public abstract T forUniqueKey(String keyName,
                               Object value)
```
    Retrieve an object via unique key.
    
    Parameters:
    
    keyName -
    
    value -
    
    Returns:
  - listForKey
```
public abstract List<T> listForKey(String keyName,
                                   Object value)
```
    Retrieve all objects for a given alternative key
    
    Parameters:
    
    keyName -
    
    value -
    
    Returns:
  - countForKey
```
public abstract int countForKey(String keyName,
                                Object value)
```
    Count the number of objects associated with an alternative key
    
    Parameters:
    
    keyName -
    
    value -
    
    Returns:
  - filterChain
```
public abstract FilterChain<T> filterChain()
```
    Create a new FilterChain for this stash
    
    Returns:
  - filterByKey
```
public abstract FilterChain<T> filterByKey(String key,
                                           Object lookupValue)
```
    Create a new filterChain, restricting it to items matching the lookupValue for the key
    
    Parameters:
    
    key - - a model field that has been defined as a key
    
    lookupValue -
    
    Returns:
  - filterChain
```
public abstract FilterChain<T> filterChain(List<T> subset)
```
    Create a new filter chain using a subset of items
    
    Parameters:
    
    subset -
    
    Returns:

Class Stash<T extends Model>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Stash

Method Detail

init

getController

getPersister

getBucket

getKeyFields

setKeyFields

getUniqueFields

setUniqueFields

sync

syncForSave

detach

save

hardDelete

loadAll

loadItem

loadForId

getItems

reset

onPreRead

reloadIfNewer

forId

originalForId

forUniqueKey

listForKey

countForKey

filterChain

filterByKey

filterChain