uk.ac.ed.epcc.webapp.preferences

Class AbstractUserSettingFactory<D,T,S extends AbstractUserSettingFactory.UserSetting<D>>

java.lang.Object

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

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

Type Parameters:

D - Type of the setting value

T - Database persistance type

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>

Direct Known Subclasses:

UserSettingFactory, UserStringSettingFactory

public abstract class AbstractUserSettingFactory<D,T,S extends AbstractUserSettingFactory.UserSetting<D>>
extends DataObjectFactory<S>

An abstract class to hold user Preference settings. This can be sub-classed to store settings with different datatypes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractUserSettingFactory.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

Modifier and Type	Field and Description
static Feature	PER_USER_SETTINGS_FEATURE
static java.lang.String	PERSON_FIELD
static java.lang.String	SETTING_FIELD
static java.lang.String	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
AbstractUserSettingFactory(AppContext conn, java.lang.String table)

Method Summary

Modifier and Type	Method and Description
void	clearPreference(PreferenceSetting<D> pref)
protected TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String table) Get the default table specification if the table is to be created.
protected abstract FieldType<T>	getFieldType()
D	getPreference(PreferenceSetting<D> pref)
java.lang.Class<S>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
boolean	hasPreference(PreferenceSetting<D> pref)
S	makeSetting(PreferenceSetting<D> pref, boolean create)
void	setPreference(PreferenceSetting<D> pref, D value)

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

Field Detail

PER_USER_SETTINGS_FEATURE

public static final Feature PER_USER_SETTINGS_FEATURE

PERSON_FIELD

public static final java.lang.String PERSON_FIELD

See Also:

Constant Field Values

SETTING_FIELD

public static final java.lang.String SETTING_FIELD

See Also:

Constant Field Values

VALUE_FIELD

public static final java.lang.String VALUE_FIELD

See Also:

Constant Field Values

Constructor Detail

AbstractUserSettingFactory

public AbstractUserSettingFactory(AppContext conn,
                                  java.lang.String table)

Method Detail

getPreference

public D getPreference(PreferenceSetting<D> pref)

hasPreference

public boolean hasPreference(PreferenceSetting<D> pref)

clearPreference

public void clearPreference(PreferenceSetting<D> pref)
                     throws DataFault

Throws:

DataFault

setPreference

public void setPreference(PreferenceSetting<D> pref,
                          D value)

makeSetting

public S makeSetting(PreferenceSetting<D> pref,
                     boolean create)

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 AbstractUserSettingFactory.UserSetting<D>>

Specified by:

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

Overrides:

getTarget in class DataObjectFactory<S extends AbstractUserSettingFactory.UserSetting<D>>

Returns:

Class object for return type

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

Parameters:

c - AppContext

table - String table name.

Returns:

null or TableSpecification

getFieldType

protected abstract FieldType<T> getFieldType()