Package org.openxava.actions

Class SimpleTemplaterAction

java.lang.Object

org.openxava.actions.BaseAction

org.openxava.actions.ViewBaseAction

org.openxava.actions.TabBaseAction

org.openxava.actions.SimpleTemplaterAction

All Implemented Interfaces:

IAction, IChangeModeAction, IModelAction, IModuleContextAction, IRequestAction

Direct Known Subclasses:

SimpleHTMLReportAction

public class SimpleTemplaterAction
extends TabBaseAction
implements IModelAction

Author:

Laurent Wibaux

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION
protected static final int	MAX_DEPTH

Fields inherited from interface org.openxava.actions.IChangeModeAction

DETAIL, LIST, PREVIOUS_MODE, SPLIT

Constructor Summary

Constructors

Constructor	Description
SimpleTemplaterAction()

Method Summary

Modifier and Type	Method	Description
void	execute()
protected Map<String,String>	getClassParameters(Class<?> aClass, int maxDepth)	Get a map of [name, ""] for the passed class
protected static Vector<Map<String,String>>	getCollectionParametersList(Collection<?> collection)	Get a list of maps of [name, value] for each one of the objects in the passed collection
protected static Vector<Map<String,String>>	getCollectionParametersList(Collection<?> collection, int maxDepth)	Get a list of maps of [name, value] for each one of the objects in the passed collection
String	getCollectionTable(Class<?> collectionEntityClass, String collectionName)
String	getCollectionTable(Class<?> collectionEntityClass, String collectionName, int maxDepth)
String	getDepth()
protected static Map<String,String>	getEntityParameters(Object entity)	Get a map of [name, value] for the passed object
protected Map<String,String>	getEntityParameters(Object entity, int maxDepth)	Get a map of [name, value] for the passed object
protected Map<String,String>	getEntityParameters(Object entity, String parentName, int maxDepth)	Get a map of [name, value] for the passed object
String	getFieldsTable(Object entity, int depth)
protected Map<String,Object>	getParameters()
String	getTemplate()
String	getValuesTable(Object entity, int depth)
void	setDepth(String depth)
void	setModel(String modelName)
void	setTemplate(String template)

Methods inherited from class org.openxava.actions.TabBaseAction

getCollection, getRow, getSelected, getSelectedKeys, getTab, setCollection, setRow, setViewObject

Methods inherited from class org.openxava.actions.ViewBaseAction

changeThisPropertyByViewValue, closeDialog, getModelName, getPreviousView, getPreviousViews, getView, resetDescriptionsCache, returnToPreviousView, setControllers, setPreviousViews, setView, showDialog, showDialog, showNewView, showView, validateViewValues

Methods inherited from class org.openxava.actions.BaseAction

addActions, addError, addErrors, addInfo, addMessage, addMessages, addWarning, clearActions, commit, executeAction, executeAfter, executeBefore, getContext, getEnvironment, getErrors, getLocale, getManager, getMessages, getNextMode, getQualifiedActionIfAvailable, getRequest, removeActions, returnToPreviousControllers, rollback, setContext, setDefaultControllers, setEnvironment, setErrors, setMessages, setNextMode, setRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openxava.actions.IAction

getErrors, getMessages, setEnvironment, setErrors, setMessages

Field Details

COLLECTION

public static final String COLLECTION

See Also:

• Constant Field Values

MAX_DEPTH

protected static final int MAX_DEPTH

See Also:

• Constant Field Values

Constructor Details

SimpleTemplaterAction

public SimpleTemplaterAction()

Method Details

execute

public void execute()
             throws Exception

Specified by:

execute in interface IAction

Throws:

Exception

getParameters

protected Map<String,Object> getParameters()
                                    throws Exception

Throws:

Exception

setModel

public void setModel(String modelName)

Specified by:

setModel in interface IModelAction

getFieldsTable

public String getFieldsTable(Object entity,
 int depth)
                      throws Exception

Throws:

Exception

getValuesTable

public String getValuesTable(Object entity,
 int depth)
                      throws Exception

Throws:

Exception

getCollectionTable

public String getCollectionTable(Class<?> collectionEntityClass,
 String collectionName)
                          throws Exception

Throws:

Exception

getCollectionTable

public String getCollectionTable(Class<?> collectionEntityClass,
 String collectionName,
 int maxDepth)
                          throws Exception

Throws:

Exception

getTemplate

public String getTemplate()

setTemplate

public void setTemplate(String template)

setDepth

public void setDepth(String depth)

getDepth

public String getDepth()

getEntityParameters

protected static Map<String,String> getEntityParameters(Object entity)
                                                 throws Exception

Get a map of [name, value] for the passed object

Parameters:

entity - - the Object to parse

maxDepth - - the maximum depth while parsing the ManyToOne fields

Returns:

the map of field names and values

Throws:

Exception

getEntityParameters

protected Map<String,String> getEntityParameters(Object entity,
 int maxDepth)
                                          throws Exception

Get a map of [name, value] for the passed object

Parameters:

entity - - the Object to parse

maxDepth - - the maximum depth while parsing the ManyToOne fields

Returns:

the map of field names and values

Throws:

Exception

getEntityParameters

protected Map<String,String> getEntityParameters(Object entity,
 String parentName,
 int maxDepth)
                                          throws Exception

Get a map of [name, value] for the passed object

Parameters:

entity - - the Object to parse

parentName - - the prefix to put in front of every name

maxDepth - - the maximum depth while parsing the ManyToOne fields

Returns:

the map of field names and values

Throws:

Exception

getClassParameters

protected Map<String,String> getClassParameters(Class<?> aClass,
 int maxDepth)
                                         throws Exception

Get a map of [name, ""] for the passed class

Parameters:

class - - the Class to parse

maxDepth - - the maximum depth while parsing the ManyToOne fields

Returns:

the map of field names and values

Throws:

Exception

getCollectionParametersList

protected static Vector<Map<String,String>> getCollectionParametersList(Collection<?> collection)
                                                                 throws Exception

Get a list of maps of [name, value] for each one of the objects in the passed collection

Parameters:

collection - - the Collection to parse

Returns:

the list of maps

Throws:

Exception

getCollectionParametersList

protected static Vector<Map<String,String>> getCollectionParametersList(Collection<?> collection,
 int maxDepth)
                                                                 throws Exception

Get a list of maps of [name, value] for each one of the objects in the passed collection

Parameters:

collection - - the Collection to parse

maxDepth - - the maximum depth while parsing the ManyToOne fields

Returns:

the list of maps

Throws:

Exception