org.fryske_akademy.jsf

Class AbstractEntityController<E extends EntityInterface,A extends Auditing>

java.lang.Object

org.fryske_akademy.jsf.AbstractController<A>

org.fryske_akademy.jsf.AbstractEntityController<E,A>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractLazyController

public abstract class AbstractEntityController<E extends EntityInterface,A extends Auditing>
extends AbstractController<A>

Author:

eduard

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<E>	clazz
static String	DEFAULT_BUNDLE_NAME
protected static String	FILTERING will be appended as param value in filterAndRedirect(org.fryske_akademy.jsf.AbstractEntityController, java.lang.String, java.lang.String, java.lang.String)
protected static String	STATE will be appended as param key in filterAndRedirect(org.fryske_akademy.jsf.AbstractEntityController, java.lang.String, java.lang.String, java.lang.String)

Fields inherited from class org.fryske_akademy.jsf.AbstractController

FACESREDIRECTTRUE

Constructor Summary

Constructors

Constructor and Description
AbstractEntityController(Class<E> clazz)

Method Summary

Modifier and Type	Method and Description
void	cancelRow(org.primefaces.event.RowEditEvent editEvent) Calls refreshRow(org.primefaces.event.RowEditEvent, org.fryske_akademy.jpa.EntityInterface, boolean) with the canceled entity from the event and false.
void	copy() copy a selected entity, call fillCopy(org.fryske_akademy.jpa.EntityInterface, org.fryske_akademy.jpa.EntityInterface), set getNewEntity() to the copy.
E	create() calls create(org.fryske_akademy.jpa.EntityInterface) with getNewEntity().
E	create(E e) calls AbstractController.persist(org.fryske_akademy.jpa.EntityInterface, org.fryske_akademy.jsf.util.JsfUtil.PersistAction, java.lang.String).
void	destroy()
protected abstract void	fillCopy(E newEntity, E selected) implementors can fill the new object with values from selected
protected void	fillNew(E entity) empty method, called from prepareCreate()
protected String	filterAndRedirect(AbstractEntityController controller, String key, String value, String action) clears all filters, adds the key/value to it and returns your action with AbstractController.FACESREDIRECTTRUE and "state=filtering" appended.
protected String	getBundleName() override if you want to use different bundle name then DEFAULT_BUNDLE_NAME
abstract Filtering<E>	getFiltering()
Map<String,Object>	getFilters(String key) active filters on a page, use this as primefaces @filterValue: filterValue="#{ctlr.filters['id']}"
String	getFilterString(String key)
Object	getFilterValue(String key) return the value os a filter, often this will be a String.
List<RevInfo<E>>	getLastChanged(E entity, int max)
String	getLastChangedInfo(E entity) returns username, revision date and RevisionType for the last revision found
E	getNewEntity()
E	getSelected()
abstract String	gotoPageContaining(E entity) Navigate (i.e.
boolean	isRememberTableState() remember sorting, filtering, column order, selection, column widths, page number (@multiViewState).
void	onRowSelect(org.primefaces.event.SelectEvent event)
void	prepareCreate() creates a new entity and calls fillNew(org.fryske_akademy.jpa.EntityInterface)
protected void	refreshRow(org.primefaces.event.RowEditEvent editEvent, EntityInterface e, boolean update) Attempts to show data in sync with the database after an update or cancel edit.
E	save(org.primefaces.event.RowEditEvent event) Create or update an entity based on AbstractEntity.isTransient().
void	setNewEntity(E newEntity)
void	setRememberTableState(boolean rememberTableState)
void	setSelected(E selected)
E	update(org.primefaces.event.RowEditEvent editEvent) Calls AbstractController.persist(org.fryske_akademy.jpa.EntityInterface, org.fryske_akademy.jsf.util.JsfUtil.PersistAction, java.lang.String) and refreshRow(org.primefaces.event.RowEditEvent, org.fryske_akademy.jpa.EntityInterface, boolean) with the up to date entity and true.

Methods inherited from class org.fryske_akademy.jsf.AbstractController

diacriticsKeyBoard, getCrudWriteService, getSecurityContext, initCrudWriteService, persist, persist, setCrudWriteService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clazz

protected final Class<E extends EntityInterface> clazz

DEFAULT_BUNDLE_NAME

public static final String DEFAULT_BUNDLE_NAME

See Also:

Constant Field Values

STATE

protected static final String STATE

will be appended as param key in filterAndRedirect(org.fryske_akademy.jsf.AbstractEntityController, java.lang.String, java.lang.String, java.lang.String)

See Also:

Constant Field Values

FILTERING

protected static final String FILTERING

will be appended as param value in filterAndRedirect(org.fryske_akademy.jsf.AbstractEntityController, java.lang.String, java.lang.String, java.lang.String)

See Also:

Constant Field Values

Constructor Detail

AbstractEntityController

public AbstractEntityController(Class<E> clazz)

Method Detail

isRememberTableState

public boolean isRememberTableState()

remember sorting, filtering, column order, selection, column widths, page number (@multiViewState). NOTE this may overwrite filter value set from filterAndRedirect(org.fryske_akademy.jsf.AbstractEntityController, java.lang.String, java.lang.String, java.lang.String) subclasses may therefore choose to check if a request parameter "state" equals "filtering".

Returns:

setRememberTableState

public void setRememberTableState(boolean rememberTableState)

getSelected

public E getSelected()

setSelected

public void setSelected(E selected)

getNewEntity

public E getNewEntity()

setNewEntity

public void setNewEntity(E newEntity)

onRowSelect

public void onRowSelect(org.primefaces.event.SelectEvent event)

prepareCreate

public final void prepareCreate()
                         throws InstantiationException,
                                IllegalAccessException

creates a new entity and calls fillNew(org.fryske_akademy.jpa.EntityInterface)

Throws:

InstantiationException

IllegalAccessException

create

public E create()

calls create(org.fryske_akademy.jpa.EntityInterface) with getNewEntity().

create

public E create(E e)

calls AbstractController.persist(org.fryske_akademy.jpa.EntityInterface, org.fryske_akademy.jsf.util.JsfUtil.PersistAction, java.lang.String). Uses property "Created" from bundle as message.

getBundleName

protected String getBundleName()

override if you want to use different bundle name then DEFAULT_BUNDLE_NAME

Returns:

getFiltering

public abstract Filtering<E> getFiltering()

getFilterValue

public Object getFilterValue(String key)

return the value os a filter, often this will be a String.

Parameters:

key -

Returns:

getFilterString

public String getFilterString(String key)

getFilters

public Map<String,Object> getFilters(String key)

active filters on a page, use this as primefaces @filterValue: filterValue="#{ctlr.filters['id']}"

Parameters:

key -

Returns:

gotoPageContaining

public abstract String gotoPageContaining(E entity)

Navigate (i.e. in a datatable) to the page containing the argument entity. Implementors can call Filtering.clear().add(java.lang.String, java.lang.Object) and then for example redirect and use viewParam

Parameters:

entity -

Returns:

the action to perform

fillCopy

protected abstract void fillCopy(E newEntity,
                                 E selected)

implementors can fill the new object with values from selected

Parameters:

newEntity -

selected -

fillNew

protected void fillNew(E entity)

empty method, called from prepareCreate()

Parameters:

entity -

copy

public final void copy()
                throws InstantiationException,
                       IllegalAccessException

copy a selected entity, call fillCopy(org.fryske_akademy.jpa.EntityInterface, org.fryske_akademy.jpa.EntityInterface), set getNewEntity() to the copy.

Throws:

InstantiationException

IllegalAccessException

update

public E update(org.primefaces.event.RowEditEvent editEvent)

Calls AbstractController.persist(org.fryske_akademy.jpa.EntityInterface, org.fryske_akademy.jsf.util.JsfUtil.PersistAction, java.lang.String) and refreshRow(org.primefaces.event.RowEditEvent, org.fryske_akademy.jpa.EntityInterface, boolean) with the up to date entity and true. Uses property "Updated" from bundle as message.

Parameters:

editEvent -

Returns:

the updated entity

save

public E save(org.primefaces.event.RowEditEvent event)

Create or update an entity based on AbstractEntity.isTransient().

Parameters:

event -

Returns:

the saved entity

Throws:

javax.persistence.PersistenceException - when entity is no AbstractEntity

refreshRow

protected void refreshRow(org.primefaces.event.RowEditEvent editEvent,
                          EntityInterface e,
                          boolean update)

Attempts to show data in sync with the database after an update or cancel edit. This implementation works for DataTables with a List or a DataModel wrapping a List as value.

Parameters:

editEvent -

e -

update - when

cancelRow

public void cancelRow(org.primefaces.event.RowEditEvent editEvent)

Calls refreshRow(org.primefaces.event.RowEditEvent, org.fryske_akademy.jpa.EntityInterface, boolean) with the canceled entity from the event and false.

Parameters:

editEvent -

destroy

public void destroy()

getLastChangedInfo

public String getLastChangedInfo(E entity)

returns username, revision date and RevisionType for the last revision found

Parameters:

entity -

Returns:

See Also:

Auditing.getRevisionInfo(java.io.Serializable, java.lang.Integer, java.lang.Class)

getLastChanged

public List<RevInfo<E>> getLastChanged(E entity,
                                       int max)

filterAndRedirect

protected String filterAndRedirect(AbstractEntityController controller,
                                   String key,
                                   String value,
                                   String action)

clears all filters, adds the key/value to it and returns your action with AbstractController.FACESREDIRECTTRUE and "state=filtering" appended. NOTE it may be necessary to override isRememberTableState() when the value set here is overwritten.

Parameters:

controller -

key -

value -

action -

Returns: