com.manydesigns.portofino.pageactions.m2m

Class ManyToManyAction

java.lang.Object

com.manydesigns.portofino.stripes.AbstractActionBean

com.manydesigns.portofino.pageactions.AbstractPageAction

com.manydesigns.portofino.pageactions.m2m.ManyToManyAction

All Implemented Interfaces:

DispatchElement, PageAction, ActionBean

public class ManyToManyAction
extends AbstractPageAction

Author:

Paolo Predonzani - paolo.predonzani@manydesigns.com, Angelo Lupo - angelo.lupo@manydesigns.com, Giampiero Granatella - giampiero.granatella@manydesigns.com, Alessio Stalla - alessio.stalla@manydesigns.com

Nested Class Summary

Nested classes/interfaces inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

AbstractPageAction.TerminalResource

Field Summary

Fields

Modifier and Type	Field and Description
protected List	availableAssociations
protected Map<Object,Boolean>	booleanRelation
protected Form	configurationForm
static String	copyright
protected boolean	correctlyConfigured
protected List	existingAssociations
protected ManyToManyConfiguration	m2mConfiguration
protected TableAccessor	manyTableAccessor
protected Object	onePk
protected SelectField	oneSelectField
static String	PERMISSION_UPDATE
Persistence	persistence
protected List	potentiallyAvailableAssociations
protected TableAccessor	relationTableAccessor
protected List<String>	selectedPrimaryKeys
protected Session	session

Fields inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

CONF_FORM_PREFIX, DEFAULT_LAYOUT_CONTAINER, PAGE_CONFIGURATION_FIELDS, PAGE_CONFIGURATION_FIELDS_NO_DETAIL, pageConfigurationForm, pageInstance, pageTemplate, PORTOFINO_PAGEACTION_EXCEPTION, portofinoConfiguration, returnUrl, script, serverInfo, templates

Fields inherited from class com.manydesigns.portofino.stripes.AbstractActionBean

context

Constructor Summary

Constructors

Constructor and Description
ManyToManyAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addSpRefSelectionProvider(List<ModelSelectionProvider> sps, Form form, String fieldName)
Resolution	configure()
DefaultSelectionProvider	createSelectionProviderFromHql(String name, String databaseName, String hql, DisplayMode dm, SearchDisplayMode sdm)
protected void	deleteRelation(Object rel)
Resolution	execute()
Resolution	getAsJson() Handles available keys via REST.
List<?>	getAvailableAssociations()
Map<Object,Boolean>	getBooleanRelation()
ManyToManyConfiguration	getConfiguration()
Form	getConfigurationForm()
List<?>	getExistingAssociations()
TableAccessor	getManyTableAccessor()
Object	getOnePk()
SelectField	getOneSelectField()
TableAccessor	getRelationTableAccessor()
List<String>	getSelectedPrimaryKeys()
Response	httpPostJson(String jsonObject) Handles object creation via REST.
Resolution	jsonAssociations()
Resolution	jsonKeys()
protected void	loadAssociations()
protected void	loadOnePk(Object key)
protected Response	objectCreated()
void	prepare()
protected void	prepareConfigurationForms() Sets up the Elements form(s)
Resolution	preparePage() A lifecycle method invoked during the dispatch phase, where a http request is translated to a dispatch (a path in the page tree) ultimately leading to an action invocation.
protected void	prepareSave(Object newRelation)
Resolution	saveCheckboxes()
protected Object	saveNewRelation(Object pk, PropertyAccessor onePropertyAccessor, PropertyAccessor manyPropertyAccessor)
Resolution	selectionProviders(String key) Handles available associations for given key
void	setOnePk(Object onePk)
void	setSelectedPrimaryKeys(List<String> selectedPrimaryKeys)
Resolution	updateConfiguration()
protected Resolution	view()

Methods inherited from class com.manydesigns.portofino.pageactions.AbstractPageAction

acceptsPathParameter, cancel, consumePathFragment, createTemplateSelectionProvider, forwardTo, forwardToPageActionError, forwardToPageActionNotConfigured, getActionAPIPath, getActionPath, getButtons, getDefaultReturnUrl, getEmbeddedPageActions, getOgnlContext, getPage, getPageConfigurationForm, getPageDescription, getPageInstance, getPages, getPageTemplate, getParent, getPortofinoConfiguration, getResourcePath, getReturnUrl, getScript, getSubResource, initEmbeddedPageActions, isMultipartRequest, prepareScript, readPageConfigurationFromRequest, saveConfiguration, setPageConfigurationForm, setPageInstance, setPageTemplate, setReturnUrl, setScript, updatePageConfiguration, updateScript, updateTemplate, validatePageConfiguration

Methods inherited from class com.manydesigns.portofino.stripes.AbstractActionBean

getContext, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.manydesigns.portofino.dispatcher.PageAction

getContext

Methods inherited from interface net.sourceforge.stripes.action.ActionBean

setContext

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

PERMISSION_UPDATE

public static final String PERMISSION_UPDATE

See Also:

Constant Field Values

m2mConfiguration

protected ManyToManyConfiguration m2mConfiguration

onePk

protected Object onePk

existingAssociations

protected List existingAssociations

availableAssociations

protected List availableAssociations

potentiallyAvailableAssociations

protected List potentiallyAvailableAssociations

relationTableAccessor

protected TableAccessor relationTableAccessor

manyTableAccessor

protected TableAccessor manyTableAccessor

oneSelectField

protected SelectField oneSelectField

correctlyConfigured

protected boolean correctlyConfigured

session

protected Session session

booleanRelation

protected Map<Object,Boolean> booleanRelation

selectedPrimaryKeys

protected List<String> selectedPrimaryKeys

configurationForm

protected Form configurationForm

persistence

public Persistence persistence

Constructor Detail

ManyToManyAction

public ManyToManyAction()

Method Detail

preparePage

public Resolution preparePage()

Description copied from interface: PageAction

A lifecycle method invoked during the dispatch phase, where a http request is translated to a dispatch (a path in the page tree) ultimately leading to an action invocation. This method is invoked after the PageInstance has been injected by the framework.
Also, this method is invoked on this object after it has been invoked on the PageAction corresponding to the parent page, if any.

Returns:

either null, meaning that the dispatch process is to go forward regularly, or a Resolution to be executed, interrupting normal action invocation.

prepare

@Before
public void prepare()
             throws NoSuchFieldException

Throws:

NoSuchFieldException

createSelectionProviderFromHql

public DefaultSelectionProvider createSelectionProviderFromHql(String name,
                                                      String databaseName,
                                                      String hql,
                                                      DisplayMode dm,
                                                      SearchDisplayMode sdm)

execute

@DefaultHandler
public Resolution execute()

view

protected Resolution view()

loadAssociations

protected void loadAssociations()
                         throws NoSuchFieldException

Throws:

NoSuchFieldException

saveCheckboxes

public Resolution saveCheckboxes()
                          throws Exception

Throws:

Exception

deleteRelation

protected void deleteRelation(Object rel)

saveNewRelation

protected Object saveNewRelation(Object pk,
                     PropertyAccessor onePropertyAccessor,
                     PropertyAccessor manyPropertyAccessor)

configure

public Resolution configure()

updateConfiguration

public Resolution updateConfiguration()

prepareConfigurationForms

protected void prepareConfigurationForms()

Description copied from class: AbstractPageAction

Sets up the Elements form(s)

Overrides:

prepareConfigurationForms in class AbstractPageAction

addSpRefSelectionProvider

protected void addSpRefSelectionProvider(List<ModelSelectionProvider> sps,
                             Form form,
                             String fieldName)
                                  throws NoSuchFieldException

Throws:

NoSuchFieldException

prepareSave

protected void prepareSave(Object newRelation)

getOnePk

public Object getOnePk()

setOnePk

public void setOnePk(Object onePk)

getConfiguration

public ManyToManyConfiguration getConfiguration()

Overrides:

getConfiguration in class AbstractPageAction

getExistingAssociations

public List<?> getExistingAssociations()

getAvailableAssociations

public List<?> getAvailableAssociations()

getRelationTableAccessor

public TableAccessor getRelationTableAccessor()

getManyTableAccessor

public TableAccessor getManyTableAccessor()

getBooleanRelation

public Map<Object,Boolean> getBooleanRelation()

getSelectedPrimaryKeys

public List<String> getSelectedPrimaryKeys()

setSelectedPrimaryKeys

public void setSelectedPrimaryKeys(List<String> selectedPrimaryKeys)

getConfigurationForm

public Form getConfigurationForm()

getOneSelectField

public SelectField getOneSelectField()

getAsJson

@GET
@Produces(value="application/json;charset=UTF-8")
public Resolution getAsJson()

Handles available keys via REST.

Returns:

key set results (key, label) as JSON (streamed using a Stripes Resolution).

Since:

4.2.1

selectionProviders

@GET
@Path(value=":availableAssociations/{key}")
@Produces(value="application/json;charset=UTF-8")
public Resolution selectionProviders(@PathParam(value="key")
                                                        String key)

Handles available associations for given key

Parameters:

key - the key string

Returns:

available associations set results as JSON (streamed using a Stripes Resolution).

Since:

4.2.1

loadOnePk

protected void loadOnePk(Object key)
                  throws Exception

Throws:

Exception

httpPostJson

@POST
@Produces(value="application/json;charset=UTF-8")
@Consumes(value="application/json;charset=UTF-8")
public Response httpPostJson(String jsonObject)
                      throws Exception

Handles object creation via REST.

Parameters:

jsonObject - the object (in serialized JSON form)

Returns:

the created object as JSON (in a JAX-RS Response).

Throws:

Exception - only to make the compiler happy. Nothing should be thrown in normal operation. If this method throws, it is probably a bug.

Since:

4.2.1

objectCreated

protected Response objectCreated()
                          throws URISyntaxException

Throws:

URISyntaxException

jsonKeys

public Resolution jsonKeys()
                    throws org.json.JSONException

Throws:

org.json.JSONException

jsonAssociations

public Resolution jsonAssociations()
                            throws org.json.JSONException

Throws:

org.json.JSONException