uk.ac.ed.epcc.webapp.model.serv

Class DataObjectDataProducer<D extends DataObjectDataProducer.MimeData>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.serv.DataObjectDataProducer<D>

Type Parameters:

D -

All Implemented Interfaces:

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

public class DataObjectDataProducer<D extends DataObjectDataProducer.MimeData>
extends DataObjectFactory<D>
implements SettableServeDataProducer, AnonymisingFactory

A SettableServeDataProducer implemented as a database table. It is intended to be a straightforward replacement for SessionDataProducer trading off database space and overhead for memory in the user session. Note that if sessions are being persisted to the database then the SessionDataProducer will also consume database space though this will automatically be reclaimed at the end of the session. It can also be extended to provide more sophisticated access control Each item of data belongs to a single user and expires after a specified date

See Also:

DataProducerHeartbeatListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataObjectDataProducer.MimeData

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
DataObjectDataProducer(AppContext c, java.lang.String tag)

Method Summary

Modifier and Type	Method and Description
void	anonymise()
void	clean()
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.
TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String tag) 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.
DataObjectDataProducer.MimeData	getMimeData(SessionService user, java.util.List<java.lang.String> path)
protected D	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.
java.util.List<java.lang.String>	setData(MimeStreamData data) Store a MimeStreamData object generating a new path location

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, 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

DataObjectDataProducer

public DataObjectDataProducer(AppContext c,
                              java.lang.String tag)

Method Detail

getDefaultTableSpecification

public TableSpecification getDefaultTableSpecification(AppContext c,
                                                       java.lang.String tag)

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<D extends DataObjectDataProducer.MimeData>

Parameters:

c - AppContext

tag - String table name.

Returns:

null or TableSpecification

clean

public void clean()

getMimeData

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

Throws:

java.lang.Exception

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

setData

public java.util.List<java.lang.String> setData(MimeStreamData data)

Description copied from interface: SettableServeDataProducer

Store a MimeStreamData object generating a new path location

Specified by:

setData in interface SettableServeDataProducer

Parameters:

data - Data to add

Returns:

path to stored data

makeBDO

protected D makeBDO(Repository.Record res)
             throws DataFault

Description copied from class: DataObjectFactory

Construct a new Blank DataObject of the correct Class This method takes a Record as an argument. This allows the factory to either create different sub-classes depending on a value in the record or to produce objects from different Repositories/tables. We keep the return type as DataObject instead of making it generic as this helps with legacy compatibility a little bit (problem is if we have another generic sub-type between us and a legacy sub-class

Specified by:

makeBDO in class DataObjectFactory<D extends DataObjectDataProducer.MimeData>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

anonymise

public void anonymise()
               throws DataFault

Specified by:

anonymise in interface AnonymisingFactory

Throws:

DataFault