uk.ac.ed.epcc.webapp.model.far.response

Class ResponseManager<R extends ResponseManager.Response<F>,F extends DynamicFormManager.DynamicForm>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<R>

uk.ac.ed.epcc.webapp.model.far.response.ResponseManager<R,F>

Type Parameters:

R - type of ResponseManager.Response

F - type of DynamicFormManager.DynamicForm

All Implemented Interfaces:

Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<R>, FilterMatcher<R>, TypeConverter<R,java.lang.Number>, DataObjectSelector<R>, Selector<DataObjectItemInput<R>>, Owner<R>, IndexedProducer<R>, ServeDataProducer, Tagged, Targetted<R>

Direct Known Subclasses:

PersonalResponseManager

public abstract class ResponseManager<R extends ResponseManager.Response<F>,F extends DynamicFormManager.DynamicForm>
extends DataObjectFactory<R>
implements ServeDataProducer

a factory for responses to DynamicFormManager.DynamicForms. This class is abstract because much of the behaviour (specifically how responses are created and the rules for who can edit a response) are very specific to the surrounding logic. ResponseManagers implement ServeDataProducer allowing any user

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResponseManager.Response<D extends DynamicFormManager.DynamicForm> This represents a response to a DynamicFormManager.DynamicForm The logic for how a response is generated (and how the form we are responding to is selected) is up to the sub-class.

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

DataObjectFactory.AbstractDataObjectInput, DataObjectFactory.AbstractFinder<X>, DataObjectFactory.DataObjectAcceptFilter, DataObjectFactory.DataObjectInput, DataObjectFactory.DataObjectIntegerInput, DataObjectFactory.DestAcceptFilter<T extends DataObject>, DataObjectFactory.FilterAdapter, DataObjectFactory.FilterCounter, DataObjectFactory.FilterExists, DataObjectFactory.FilterIterator, DataObjectFactory.FilterSelector, DataObjectFactory.FilterSet, DataObjectFactory.Finder, DataObjectFactory.MakeRemoteFilterVisitor<R extends DataObject>, DataObjectFactory.MatchFilter, DataObjectFactory.ReferencedAdapter<I extends Indexed>, DataObjectFactory.ReferenceIterator<I extends Indexed>, DataObjectFactory.SortingDataObjectInput, DataObjectFactory.TimeAcceptFilter<T extends DataObject>, DataObjectFactory.TimeFilter

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

AUTO_CREATE_TABLES_FEATURE, COMPOSITES_SUFFIX, REJECT_MULTIPLE_RESULT_FEATURE, res

Fields inherited from interface uk.ac.ed.epcc.webapp.model.serv.ServeDataProducer

DEFAULT_SERVE_DATA_TAG

Constructor Summary

Constructors

Constructor and Description
ResponseManager(DynamicFormManager<F> manager, java.lang.String tag)

Method Summary

Modifier and Type	Method and Description
<T> T	getData(QuestionManager.Question q, R response) get the data from a Question from a response
MimeStreamData	getData(SessionService user, java.util.List<java.lang.String> path) Get a MimeStreamData corresponding to the data to be served This method also implements access control and returns null if access is denied.
protected ResponseDataManager<?,R,F>	getDataManager(QuestionManager.Question q) get the ResponseDataManager that handles the data generated by a question.
protected TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String table) Get the default table specification if the table is to be created.
java.lang.String	getDownloadName(SessionService user, java.util.List<java.lang.String> path) get a download file-name to be added to a download link.
SQLFilter<R>	getFormFilter(F form) get a filter for all responses to a particular form.
DynamicFormManager<F>	getManager() Get the DynamicFormManager corresponding to this response
<T> ServeDataResult	getServeResult(ResponseDataManager.ResponseData<T,R,F> wrapper) get a ServeDataResult (for a download link) from a ResponseDataManager.ResponseData
<T> ResponseDataManager.ResponseData<T,R,F>	getWrapper(QuestionManager.Question q, R response) get the ResponseDataManager.ResponseData object.
<T> void	setData(QuestionManager.Question q, R response, T data) set the data for a question and response

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

all, allowPreSelect, canCreate, canUpdate, checkComposite, convertToDestinationFilter, customiseForm, equals, exists, find, find, find, find, find, getAllIterator, getComposite, getComposites, getComposites, getConfigTag, getContext, getCount, getDefaultRelationshipFilter, getDefaults, getDestFilter, getExcludeFilter, getFieldConstraints, getFieldHelp, getFilter, getFilter, getFilter, getFinalSelectFilter, getFinalTableSpecification, getFindFilter, getFormCreator, getFormUpdate, getID, getIndex, getInput, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOptional, getOrder, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getSelectors, getSupress, getTableSpecification, getTableStructureContributers, getTag, getTarget, getTranslations, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeBDO, makeObject, makeRecord, makeReference, makeReference, matches, narrowSelector, narrowSelector, observeComposite, OrderBy, postCreateTableSetup, postSetContext, release, restrictDefaultInput, setComposites, setContext, setContext, setContextWithMake, setProperty, toString, updateTable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.webapp.Tagged

getTag

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Constructor Detail

ResponseManager

public ResponseManager(DynamicFormManager<F> manager,
                       java.lang.String tag)

Method Detail

getManager

public DynamicFormManager<F> getManager()

Get the DynamicFormManager corresponding to this response

Returns:

getData

public <T> T getData(QuestionManager.Question q,
                     R response)
              throws java.lang.Exception

get the data from a Question from a response

Parameters:

q -

response -

Returns:

Throws:

java.lang.Exception

getWrapper

public <T> ResponseDataManager.ResponseData<T,R,F> getWrapper(QuestionManager.Question q,
                                                              R response)
                                                       throws java.lang.Exception,
                                                              java.lang.NoSuchMethodException,
                                                              java.lang.InstantiationException,
                                                              java.lang.IllegalAccessException,
                                                              java.lang.reflect.InvocationTargetException,
                                                              DataException

get the ResponseDataManager.ResponseData object.

Parameters:

q -

response -

Returns:

ResponseDataManager.ResponseData or null;

Throws:

java.lang.Exception

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

DataException

setData

public <T> void setData(QuestionManager.Question q,
                        R response,
                        T data)
                 throws java.lang.Exception

set the data for a question and response

Parameters:

q -

response -

data -

Throws:

java.lang.Exception

getDataManager

protected ResponseDataManager<?,R,F> getDataManager(QuestionManager.Question q)
                                             throws java.lang.Exception,
                                                    java.lang.NoSuchMethodException,
                                                    java.lang.InstantiationException,
                                                    java.lang.IllegalAccessException,
                                                    java.lang.reflect.InvocationTargetException

get the ResponseDataManager that handles the data generated by a question. Questions with the same type of response data can share a ResponseDataManager.

Parameters:

q - the QuestionManager.Question

Returns:

Throws:

java.lang.Exception

java.lang.NoSuchMethodException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

getDefaultTableSpecification

protected TableSpecification getDefaultTableSpecification(AppContext c,
                                                          java.lang.String table)

Description copied from class: DataObjectFactory

Get the default table specification if the table is to be created. A null result means that a default specification is not available and the table will not be created.

Overrides:

getDefaultTableSpecification in class DataObjectFactory<R extends ResponseManager.Response<F>>

Parameters:

c - AppContext

table - String table name.

Returns:

null or TableSpecification

getFormFilter

public SQLFilter<R> getFormFilter(F form)

get a filter for all responses to a particular form.

Parameters:

form -

Returns:

getServeResult

public <T> ServeDataResult getServeResult(ResponseDataManager.ResponseData<T,R,F> wrapper)
                                   throws DataException

get a ServeDataResult (for a download link) from a ResponseDataManager.ResponseData

Parameters:

wrapper -

Returns:

Throws:

DataException

getData

public MimeStreamData getData(SessionService user,
                              java.util.List<java.lang.String> path)
                       throws java.lang.Exception

Description copied from interface: ServeDataProducer

Get a MimeStreamData corresponding to the data to be served This method also implements access control and returns null if access is denied. Note that the SessionService may not have a current person set so you have to check for null SessionService and null AppUser as well as the users permissions.

Specified by:

getData in interface ServeDataProducer

Returns:

MimeStreamData or null

Throws:

java.lang.Exception

getDownloadName

public java.lang.String getDownloadName(SessionService user,
                                        java.util.List<java.lang.String> path)
                                 throws java.lang.Exception

Description copied from interface: ServeDataProducer

get a download file-name to be added to a download link. This should be the same as the value returned by MimeStreamData.getName() if ServeDataProducer.getData(SessionService, List) returns a non-null value. However this method may be called by display content generation code so if the result is generated on the fly it might be possible to generate the download name in a more lightweight fashion. It should also work to always return null thought he browser will use the last part of the selection path as the download

Specified by:

getDownloadName in interface ServeDataProducer

Returns:

Throws:

java.lang.Exception