io.stallion.dataAccess

Interface Persister<T extends Model>

Type Parameters:

T -

All Known Implementing Classes:

AsyncTaskDbPersister, AsyncTaskFilePersister, BasePersister, DbPersister, DummyPersister, DummyTaskPersister, FilePersisterBase, JsonFilePersister, PredefinedUsersPersister, TextFilePersister, TomlPersister

public interface Persister<T extends Model>

A Persister actually handles interaction with the data store. There are persister implementations for storing to a database, JSON files, text files, etc.

Method Summary

Modifier and Type	Method and Description
void	attachWatcher() Attach any file system watchers for changed objects
List	fetchAll() Fetch all the items from the underlying data store.
T	fetchOne(Long id) Fetch one object with the given ID
T	fetchOne(T obj) Re-fetch the passed in object from the underlying data stores
FilterChain<T>	filterChain()
String	getBucket() The bucket name associated with this persister.
ModelController<T>	getItemController() Get the controller associated with this persister
Class<T>	getModelClass() The Class of the model associated with this persister
Stash<T>	getStash() Get the Stash associated with this persister
void	handleFetchOne(T obj) Called by fetchOne() after the object has been loaded from the datastore
void	hardDelete(T obj) Permanently delete the object from the datastore
void	init(DataAccessRegistration registration, ModelController<T> controller, Stash<T> stash) Initialize the persister, called during DalRegistery.register
boolean	isDbBacked()
void	onFetchOne() Called after an object has been fetched from the data store
void	onPreRead() Called before any read operation.
void	persist(T obj) Persist the object to the underlying data store
boolean	reloadIfNewer(T obj) Reload the object if the version in the datastore is more recent than the local object
Persister<T>	setBucket(String bucket)
Persister	setItemController(ModelController<T> controller)
Persister<T>	setModelClass(Class<T> modelClass)
Persister<T>	setStash(Stash<T> stash)
default void	update(T obj, Map<String,Object> values) Update the specified values.
void	watchEventCallback(String relativePath) Callback for file-based datastores when an object is changed in the file system

Method Detail

init

void init(DataAccessRegistration registration,
          ModelController<T> controller,
          Stash<T> stash)

Initialize the persister, called during DalRegistery.register

Parameters:

registration -

controller -

stash -

getModelClass

Class<T> getModelClass()

The Class of the model associated with this persister

Returns:

setModelClass

Persister<T> setModelClass(Class<T> modelClass)

getBucket

String getBucket()

The bucket name associated with this persister.

Returns:

setBucket

Persister<T> setBucket(String bucket)

fetchAll

List fetchAll()

Fetch all the items from the underlying data store.

Returns:

fetchOne

T fetchOne(Long id)

Fetch one object with the given ID

Parameters:

id -

Returns:

fetchOne

T fetchOne(T obj)

Re-fetch the passed in object from the underlying data stores

Parameters:

obj -

Returns:

getItemController

ModelController<T> getItemController()

Get the controller associated with this persister

Returns:

setItemController

Persister setItemController(ModelController<T> controller)

getStash

Stash<T> getStash()

Get the Stash associated with this persister

Returns:

setStash

Persister<T> setStash(Stash<T> stash)

watchEventCallback

void watchEventCallback(String relativePath)

Callback for file-based datastores when an object is changed in the file system

Parameters:

relativePath -

persist

void persist(T obj)

Persist the object to the underlying data store

Parameters:

obj -

update

default void update(T obj,
                    Map<String,Object> values)

Update the specified values. For datastores that support it, it should only save the updated values to the datastore -- not the entire object.

Parameters:

obj -

values -

hardDelete

void hardDelete(T obj)

Permanently delete the object from the datastore

Parameters:

obj -

attachWatcher

void attachWatcher()

Attach any file system watchers for changed objects

handleFetchOne

void handleFetchOne(T obj)

Called by fetchOne() after the object has been loaded from the datastore

Parameters:

obj -

onFetchOne

void onFetchOne()

Called after an object has been fetched from the data store

onPreRead

void onPreRead()

Called before any read operation.

reloadIfNewer

boolean reloadIfNewer(T obj)

Reload the object if the version in the datastore is more recent than the local object

Parameters:

obj -

Returns:

filterChain

FilterChain<T> filterChain()

isDbBacked

boolean isDbBacked()