uk.ac.ed.epcc.webapp.preferences

Class UserStringSettingFactory<D,S extends UserStringSettingFactory.UserSetting<D>>

java.lang.Object

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

uk.ac.ed.epcc.webapp.preferences.AbstractUserSettingFactory<D,java.lang.String,S>

uk.ac.ed.epcc.webapp.preferences.UserStringSettingFactory<D,S>

Type Parameters:

D - target type of the PreferenceSetting

S - Type of Setting object

All Implemented Interfaces:

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

public class UserStringSettingFactory<D,S extends UserStringSettingFactory.UserSetting<D>>
extends AbstractUserSettingFactory<D,java.lang.String,S>

A class to hold user PreferenceSetting settings as strings. This uses the TypeConverter methods in the PreferenceSetting to generate the database values so any type of PreferenceSetting can be stored in the same table. For data types that can be stored natively in the database a custom AbstractUserSettingFactory might be more appropriate.

See Also:

UserSettingFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserStringSettingFactory.UserSetting<D>

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.preferences.AbstractUserSettingFactory

PER_USER_SETTINGS_FEATURE, PERSON_FIELD, SETTING_FIELD, VALUE_FIELD

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

AUTO_CREATE_TABLES_FEATURE, COMPOSITES_SUFFIX, REJECT_MULTIPLE_RESULT_FEATURE, res

Constructor Summary

Constructors

Constructor and Description
UserStringSettingFactory(AppContext conn)

Method Summary

Modifier and Type	Method and Description
protected FieldType<java.lang.String>	getFieldType()
java.lang.Class<S>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
protected S	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.

Methods inherited from class uk.ac.ed.epcc.webapp.preferences.AbstractUserSettingFactory

clearPreference, getDefaultTableSpecification, getPreference, hasPreference, makeSetting, setPreference

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

Constructor Detail

UserStringSettingFactory

public UserStringSettingFactory(AppContext conn)

Method Detail

makeBDO

protected S 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<S extends UserStringSettingFactory.UserSetting<D>>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

getTarget

public java.lang.Class<S> getTarget()

Description copied from class: DataObjectFactory

Get a bound on the type of object produced by this factory for run-time checking. This implements IndexedProducer.getTarget(). Normally this method should be overridden each time we make a sub-class that narrows the produced type. However checks should still pass if the super-type method is retained.

Specified by:

getTarget in interface IndexedProducer<S extends UserStringSettingFactory.UserSetting<D>>

Specified by:

getTarget in interface Targetted<S extends UserStringSettingFactory.UserSetting<D>>

Overrides:

getTarget in class AbstractUserSettingFactory<D,java.lang.String,S extends UserStringSettingFactory.UserSetting<D>>

Returns:

Class object for return type

getFieldType

protected FieldType<java.lang.String> getFieldType()

Specified by:

getFieldType in class AbstractUserSettingFactory<D,java.lang.String,S extends UserStringSettingFactory.UserSetting<D>>