io.stallion.dataAccess

Interface ModelController<T extends Model>

All Known Implementing Classes:

AsyncTaskController, AuditTrailController, DisplayableModelController, JobStatusController, JsPojoController, OAuthApprovalController, OAuthClientController, ReadOnlyWrapper, SimpleFormSubmissionController, StandardModelController, TextItemController, TomlItemController, TransactionLogController, UserController

public interface ModelController<T extends Model>

Method Summary

Modifier and Type	Method and Description
List<T>	all() Return a list of all objects.
default FilterChain<T>	anyOf(List<String>... filters) Short-cut for filterChain().andAnyOf(["someField", "value"], ["otherField", "anotherValue"]); Finds all items that match any of the criteria
default FilterChain<T>	anyOf(Or... ors) Short-cut for filterChain().andAnyOf(Or("someField", "someValue"), Or("someField", "someValue")); Finds all items that match any of the criteria.
int	countForKey(String keyName, Object value) Counts the items for a indexed/keyed field.
T	detach(T obj) Gets a cloned version of an object, so that you can work with the object with out affecting the live, in memory version
FilterChain<T>	filter(String name, Object value) Create a new FilterChain and set an initial filter whereby the field @name is equal to @value
FilterChain<T>	filter(String name, Object value, String op) Create a new FilterChain and initialize with an initial filter.
FilterChain<T>	filterBy(String name, Object value, FilterOperator op) Create a new FilterChain and initialize with an initial filter.
FilterChain<T>	filterByKey(String keyName, Object value) Instantiate a filter chain and start by filtering on an index/keyed field.
FilterChain<T>	filterChain() Create a new FilterChain instance for this controller.
default FilterChain<T>	find(Map<String,Object> where) Short-cut for applying filter(name, value) for every key-value pair in the dictionary.
T	forId(Long id) Loads an object by primary id.
default T	forIdOrNotFound(Long id) Calls forId() to load an object by id, raises a NotFoundException if it does not exist
T	forIdWithDeleted(Long id) Get the object by id.
T	forUniqueKey(String keyName, Object value) Look up an object by a unique key.
default T	forUniqueKeyOrNotFound(String keyName, Object value) Finds the item by key and value, raises a NotFoundException if it does not exist
String	getBucket() A name by which this controller gets accessed when it is accessed via a template, or via DalRegistry.instance().get("bucketName").
Set<String>	getKeyFields() Get all model field names that were marked as indexed/keyed using the @Key annotation on the getter
Class<T>	getModelClass() The Model class this controller manages.
Persister<T>	getPersister() The instance of the Perister class
ReadOnlyWrapper<T>	getReadonlyWrapper() Gets a controller implementation that wraps this controller, while stubbing out all the write methods.
Stash<T>	getStash() The instance of the Stash class.
Set<String>	getUniqueFields() Get all model field names that were marked as a unique key using the @UniqueKey annotation on the getter.
void	hardDelete(T obj) Actually removes the item from the underlying data store
void	init(DataAccessRegistration registration, Persister<T> persister, Stash<T> stash) Initialize the controller, loading all the key fields, setting defaults, initializing key variables, etc.
Boolean	isWritable() True if this controller can create or update objects, false if this controller is read-only.
List<T>	listForKey(String keyName, Object value) Get all items for a indexed/keyed field.
void	onPostCreate(T obj) Override this to perform some action after the object is created.
void	onPostLoadItem(T obj) Override this to perform some action after an item is loaded from the datastore
void	onPostSave(T obj) Override this to perform some action after the object is saved
default void	onPostSaveAuditTrailLog(T obj) Override this to save to the audit trail log after a save
void	onPreCreatePrepare(T obj) Override this to prepare the object with any default values before it is saved to the datastore for the first time.
void	onPreCreateValidate(T obj) Override this to prepare the validate the object before it is saved to the datastore for the very first time.
void	onPreRead()
void	onPreSavePrepare(T obj) Override this to perform an action every time before the object is saved.
void	onPreSaveValidate(T obj) Override this to validate the object before it is saved.
T	originalForId(Long id) Load an object by id, without detaching it.
T	originalForId(T id) Load an object by id, without detaching it.
void	reset() If the datastore has been synced to memory, reset() will resync everything.
void	save(T obj) Saves "obj" to the persistence layer, creating it if it does not exist.
default FilterChain<T>	search(String value, String... fields) Searches for @value in all @fields, using a case-insensitive string contains search.
void	softDelete(T obj) Calls obj.setDeleted(true) then saves the object.
default void	update(T obj, String field, Object value) Update
default void	updateValues(T obj, Map<String,Object> values) Update

Method Detail

init

void init(DataAccessRegistration registration,
          Persister<T> persister,
          Stash<T> stash)

Initialize the controller, loading all the key fields, setting defaults, initializing key variables, etc. This must be callsed before the ModelController can be used.

Parameters:

registration -

persister -

stash -

getBucket

String getBucket()

A name by which this controller gets accessed when it is accessed via a template, or via DalRegistry.instance().get("bucketName"). Usually this is the table name or the the file-system folder name (for file backed sites).

Returns:

getPersister

Persister<T> getPersister()

The instance of the Perister class

Returns:

getStash

Stash<T> getStash()

The instance of the Stash class.

Returns:

getModelClass

Class<T> getModelClass()

The Model class this controller manages.

Returns:

isWritable

Boolean isWritable()

True if this controller can create or update objects, false if this controller is read-only.

Returns:

getReadonlyWrapper

ReadOnlyWrapper<T> getReadonlyWrapper()

Gets a controller implementation that wraps this controller, while stubbing out all the write methods. This is used when passing the controller to a sandboxed plugin that may only have read-only access.

Returns:

detach

T detach(T obj)

Gets a cloned version of an object, so that you can work with the object with out affecting the live, in memory version

Parameters:

obj -

Returns:

save

void save(T obj)

Saves "obj" to the persistence layer, creating it if it does not exist. If obj is detached, it synces the fields to the in-memory object, and saves the real copy

Parameters:

obj -

update

default void update(T obj,
                    String field,
                    Object value)

Update

updateValues

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

Update

softDelete

void softDelete(T obj)

Calls obj.setDeleted(true) then saves the object.

Parameters:

obj -

hardDelete

void hardDelete(T obj)

Actually removes the item from the underlying data store

Parameters:

obj -

onPreRead

void onPreRead()

onPreSavePrepare

void onPreSavePrepare(T obj)

Override this to perform an action every time before the object is saved.

Parameters:

obj -

onPreSaveValidate

void onPreSaveValidate(T obj)

Override this to validate the object before it is saved.

Parameters:

obj -

onPreCreatePrepare

void onPreCreatePrepare(T obj)

Override this to prepare the object with any default values before it is saved to the datastore for the first time.

Parameters:

obj -

onPreCreateValidate

void onPreCreateValidate(T obj)

Override this to prepare the validate the object before it is saved to the datastore for the very first time.

Parameters:

obj -

onPostSave

void onPostSave(T obj)

Override this to perform some action after the object is saved

Parameters:

obj -

onPostSaveAuditTrailLog

default void onPostSaveAuditTrailLog(T obj)

Override this to save to the audit trail log after a save

Parameters:

obj -

onPostCreate

void onPostCreate(T obj)

Override this to perform some action after the object is created.

Parameters:

obj -

onPostLoadItem

void onPostLoadItem(T obj)

Override this to perform some action after an item is loaded from the datastore

Parameters:

obj -

all

List<T> all()

Return a list of all objects.

Returns:

filterChain

FilterChain<T> filterChain()

Create a new FilterChain instance for this controller.

Returns:

filter

FilterChain<T> filter(String name,
                      Object value)

Create a new FilterChain and set an initial filter whereby the field @name is equal to @value

Parameters:

name -

value -

Returns:

search

default FilterChain<T> search(String value,
                              String... fields)

Searches for @value in all @fields, using a case-insensitive string contains search.

Parameters:

value -

value -

Returns:

filter

FilterChain<T> filter(String name,
                      Object value,
                      String op)

Create a new FilterChain and initialize with an initial filter.

Parameters:

name -

value -

op -

Returns:

filterBy

FilterChain<T> filterBy(String name,
                        Object value,
                        FilterOperator op)

Create a new FilterChain and initialize with an initial filter.

Parameters:

name -

value -

op -

Returns:

find

default FilterChain<T> find(Map<String,Object> where)

Short-cut for applying filter(name, value) for every key-value pair in the dictionary. Use from javascript as so: controller.find({'author': 'Mark Twain', 'type': 'short-story'});

Parameters:

where - - a map of key value pairs to find matching objets of

Returns:

anyOf

default FilterChain<T> anyOf(Or... ors)

Short-cut for filterChain().andAnyOf(Or("someField", "someValue"), Or("someField", "someValue")); Finds all items that match any of the criteria.

anyOf

default FilterChain<T> anyOf(List<String>... filters)

Short-cut for filterChain().andAnyOf(["someField", "value"], ["otherField", "anotherValue"]); Finds all items that match any of the criteria

filterByKey

FilterChain<T> filterByKey(String keyName,
                           Object value)

Instantiate a filter chain and start by filtering on an index/keyed field.

Parameters:

keyName -

value -

Returns:

forIdWithDeleted

T forIdWithDeleted(Long id)

Get the object by id. Will return objects that have been soft-deleted.

Parameters:

id -

Returns:

originalForId

T originalForId(T id)

Load an object by id, without detaching it. Changes to the object will affect the object stashed in memory. Do not use this unless you know what you are doing.

Parameters:

id -

Returns:

forId

T forId(Long id)

Loads an object by primary id. Detaches/clones the returned object so that changes will not affect the original object. Missing or soft deleted objects will return as null.

Parameters:

id -

Returns:

forIdOrNotFound

default T forIdOrNotFound(Long id)

Calls forId() to load an object by id, raises a NotFoundException if it does not exist

Parameters:

id -

Returns:

originalForId

T originalForId(Long id)

Load an object by id, without detaching it. Changes to the object will affect the object stashed in memory. Do not use this unless you know what you are doing.

Parameters:

id -

Returns:

forUniqueKey

T forUniqueKey(String keyName,
               Object value)

Look up an object by a unique key. Only works if the @UniqueKey annotation has been added to the getter of the property.

Parameters:

keyName -

value -

Returns:

forUniqueKeyOrNotFound

default T forUniqueKeyOrNotFound(String keyName,
                                 Object value)

Finds the item by key and value, raises a NotFoundException if it does not exist

Parameters:

keyName -

value -

Returns:

listForKey

List<T> listForKey(String keyName,
                   Object value)

Get all items for a indexed/keyed field. This only works if the @Key annotation has been added to the getter of the property

Parameters:

keyName -

value -

Returns:

countForKey

int countForKey(String keyName,
                Object value)

Counts the items for a indexed/keyed field. This only works if the @Key annotation has been added to the getter of the property

Parameters:

keyName -

value -

Returns:

getKeyFields

Set<String> getKeyFields()

Get all model field names that were marked as indexed/keyed using the @Key annotation on the getter

Returns:

getUniqueFields

Set<String> getUniqueFields()

Get all model field names that were marked as a unique key using the @UniqueKey annotation on the getter.

Returns:

reset

void reset()

If the datastore has been synced to memory, reset() will resync everything.