uk.ac.ed.epcc.webapp.model

Class ClassificationFactory<T extends Classification>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.ClassificationFactory<T>

Type Parameters:

T -

All Implemented Interfaces:

java.lang.Comparable<ClassificationFactory>, Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<T>, NameInputProvider<T>, FilterMatcher<T>, TypeConverter<T,java.lang.Number>, DataObjectSelector<T>, Selector<DataObjectItemInput<T>>, Owner<T>, IndexedProducer<T>, HistoryFieldContributor, NameFinder<T>, ParseFactory<T>, Tagged, Targetted<T>

Direct Known Subclasses:

DataStore, LockFactory, PreferedViewFactory

public class ClassificationFactory<T extends Classification>
extends DataObjectFactory<T>
implements java.lang.Comparable<ClassificationFactory>, HistoryFieldContributor, NameFinder<T>, NameInputProvider<T>

Factory class for Classification objects. Table will auto create if it does not exist.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ClassificationFactory.ClassificationCodeListInput
class	ClassificationFactory.ClassificationCreator
static class	ClassificationFactory.ClassificationUpdater<C extends Classification>
class	ClassificationFactory.NameItemInput An DataObjectItemInput that uses the ParseFactory.findFromString(String) method to locate Note this is not constrained by the select filter so can be used to locate retired objects.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClassificationFactory()
	ClassificationFactory(AppContext ctx, java.lang.String homeTable)

Method Summary

Modifier and Type	Method and Description
void	addToHistorySpecification(TableSpecification spec) add fields to the history table default specification.
protected boolean	allowNameChange() Does the update allow name changes.
protected boolean	allowSpacesInName()
int	compareTo(ClassificationFactory o)
void	customiseForm(Form f) Extension hook to allow additional Form customisation generic to all types of Form For example adding a FormValidator or adding min, max values to NumberInputs.
T	findFromString(java.lang.String name) Find an existing entry by name This should use the same logic as NameFinder.getStringFinderFilter(String).
DataObjectItemInput<T>	getAutocompleteInput(BaseFilter<T> fil, boolean create, boolean restrict)
java.lang.String	getCanonicalName(T object) Get a canonical name of an object in a format that can be parsed by the ParseFactory.findFromString(String) method.
IndexedDataCache<java.lang.String,T>	getDataCache() get a DataCache for fetching the target
TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String homeTable) Get the default table specification if the table is to be created.
FormCreator	getFormCreator(AppContext c) Create a default FormCreator for the target object The form may be customised according to the requesting AppUser
FormUpdate<T>	getFormUpdate(AppContext c) produce a FormUpdate for the target type appropriate for the requesting user
HistoryFactory<T,HistoryFactory.HistoryRecord<T>>	getHistoryFactory()
DataObjectItemInput<T>	getInput(BaseFilter<T> fil, boolean restrict) Generate the default input type.
CodeListInput<T>	getNameInput() Get a String valued pull-down input for the classifiers
CodeListInput<T>	getNameInput(BaseFilter<T> fil)
protected java.util.Set<java.lang.String>	getOptional() generate the set of optional fields to be used to provide class specific defaults in form creation/update.
protected java.util.List<OrderClause>	getOrder()
SQLValueFilter<T>	getStringFinderFilter(java.lang.String name) get a filter than locates the target object from a String.
java.lang.Class<T>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
protected java.util.Map<java.lang.String,java.lang.String>	getTranslations() return a default set of translation between field names and text labels.
protected T	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.
T	makeFromString(java.lang.String name) Same as NameFinder.findFromString(String) but attempts to create a matching entry if one does not exist and this is supported by the implementing class.
protected void	postCreateTableSetup(AppContext c, java.lang.String table)
protected void	postMakeByName(T c, java.lang.String name) extension point to allow side effects when a new object is auto-created.
boolean	useAutoCompleteInput(BaseFilter<T> fil)
void	validateNameFormat(java.lang.String name) Check formatting constraints on the input string.

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

all, allowPreSelect, canCreate, canUpdate, checkComposite, convertToDestinationFilter, 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, getID, getIndex, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getSelectors, getSupress, getTableSpecification, getTableStructureContributers, getTag, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeObject, makeRecord, makeReference, makeReference, matches, narrowSelector, narrowSelector, observeComposite, OrderBy, 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

ClassificationFactory

protected ClassificationFactory()

ClassificationFactory

public ClassificationFactory(AppContext ctx,
                             java.lang.String homeTable)

Method Detail

getHistoryFactory

public HistoryFactory<T,HistoryFactory.HistoryRecord<T>> getHistoryFactory()

getDefaultTableSpecification

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

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<T extends Classification>

Parameters:

c - AppContext

homeTable - String table name.

Returns:

null or TableSpecification

postCreateTableSetup

protected void postCreateTableSetup(AppContext c,
                                    java.lang.String table)

Overrides:

postCreateTableSetup in class DataObjectFactory<T extends Classification>

makeBDO

protected T 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<T extends Classification>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

getTarget

public java.lang.Class<T> 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<T extends Classification>

Specified by:

getTarget in interface Targetted<T extends Classification>

Overrides:

getTarget in class DataObjectFactory<T extends Classification>

Returns:

Class object for return type

findFromString

public T findFromString(java.lang.String name)

Description copied from interface: NameFinder

Find an existing entry by name This should use the same logic as NameFinder.getStringFinderFilter(String).

Specified by:

findFromString in interface NameFinder<T extends Classification>

Specified by:

findFromString in interface ParseFactory<T extends Classification>

Returns:

Matching T or null

getStringFinderFilter

public SQLValueFilter<T> getStringFinderFilter(java.lang.String name)

Description copied from interface: NameFinder

get a filter than locates the target object from a String. This should use the same logic as NameFinder.findFromString(String)

Specified by:

getStringFinderFilter in interface NameFinder<T extends Classification>

Parameters:

name -

Returns:

makeFromString

public T makeFromString(java.lang.String name)
                 throws DataFault

Description copied from interface: NameFinder

Same as NameFinder.findFromString(String) but attempts to create a matching entry if one does not exist and this is supported by the implementing class.

Specified by:

makeFromString in interface NameFinder<T extends Classification>

Returns:

T or null

Throws:

DataFault

postMakeByName

protected void postMakeByName(T c,
                              java.lang.String name)

extension point to allow side effects when a new object is auto-created. This is called before the commit but after setName

allowNameChange

protected boolean allowNameChange()

Does the update allow name changes. defaults to false. Override for tables that are not auto populated to allow edits.

Returns:

boolean

allowSpacesInName

protected boolean allowSpacesInName()

getFormCreator

public FormCreator getFormCreator(AppContext c)

Description copied from interface: FormCreatorProducer

Create a default FormCreator for the target object The form may be customised according to the requesting AppUser

Specified by:

getFormCreator in interface FormCreatorProducer

Overrides:

getFormCreator in class DataObjectFactory<T extends Classification>

Parameters:

c - AppContext

Returns:

FormCreator or null;

getDataCache

public IndexedDataCache<java.lang.String,T> getDataCache()

Description copied from interface: NameFinder

get a DataCache for fetching the target

Specified by:

getDataCache in interface NameFinder<T extends Classification>

Returns:

DataCache

compareTo

public int compareTo(ClassificationFactory o)

Specified by:

compareTo in interface java.lang.Comparable<ClassificationFactory>

getOrder

protected java.util.List<OrderClause> getOrder()

Overrides:

getOrder in class DataObjectFactory<T extends Classification>

getFormUpdate

public FormUpdate<T> getFormUpdate(AppContext c)

Description copied from interface: FormUpdateProducer

produce a FormUpdate for the target type appropriate for the requesting user

Specified by:

getFormUpdate in interface FormUpdateProducer<T extends Classification>

Overrides:

getFormUpdate in class DataObjectFactory<T extends Classification>

Parameters:

c - AppContext

Returns:

FormUpdate or null

customiseForm

public void customiseForm(Form f)

Description copied from class: DataObjectFactory

Extension hook to allow additional Form customisation generic to all types of Form For example adding a FormValidator or adding min, max values to NumberInputs.

Overrides:

customiseForm in class DataObjectFactory<T extends Classification>

Parameters:

f - Form to modify

getNameInput

public final CodeListInput<T> getNameInput()

Get a String valued pull-down input for the classifiers

Specified by:

getNameInput in interface NameInputProvider<T extends Classification>

Returns:

getNameInput

public final CodeListInput<T> getNameInput(BaseFilter<T> fil)

Specified by:

getNameInput in interface NameInputProvider<T extends Classification>

getTranslations

protected java.util.Map<java.lang.String,java.lang.String> getTranslations()

Description copied from class: DataObjectFactory

return a default set of translation between field names and text labels. This method provides a class specific set of defaults. The individual Form classes can still override this.

Overrides:

getTranslations in class DataObjectFactory<T extends Classification>

Returns:

Map

See Also:

DataObjectFormFactory

getOptional

protected java.util.Set<java.lang.String> getOptional()

Description copied from class: DataObjectFactory

generate the set of optional fields to be used to provide class specific defaults in form creation/update. If null is returned the default behaviour is to take fields that can be null in the database but classes can override with an explicit list of optional fields. In which case it may be a good idea to start with DataObjectFactory.getNullable() and remove any fields that should be forced to be mandatory. Alternatively you can start with an empty set (defaulting to all fields mandatory) and add exceptions Note that for legacy reasons a non-nullable String field CAN be made optional (the Repository will map null values to the empty string)

Overrides:

getOptional in class DataObjectFactory<T extends Classification>

Returns:

Vector

See Also:

DataObjectFactory.getNullable()

getCanonicalName

public java.lang.String getCanonicalName(T object)

Description copied from interface: ParseFactory

Get a canonical name of an object in a format that can be parsed by the ParseFactory.findFromString(String) method.

Specified by:

getCanonicalName in interface ParseFactory<T extends Classification>

Returns:

The canonical name.

getAutocompleteInput

public final DataObjectItemInput<T> getAutocompleteInput(BaseFilter<T> fil,
                                                         boolean create,
                                                         boolean restrict)

validateNameFormat

public void validateNameFormat(java.lang.String name)
                        throws ParseException

Description copied from interface: NameFinder

Check formatting constraints on the input string.

Specified by:

validateNameFormat in interface NameFinder<T extends Classification>

Throws:

ParseException

useAutoCompleteInput

public boolean useAutoCompleteInput(BaseFilter<T> fil)

getInput

public DataObjectItemInput<T> getInput(BaseFilter<T> fil,
                                       boolean restrict)

Description copied from class: DataObjectFactory

Generate the default input type. This is usually a ListInput but can be overidden to return an auto-complete input. Note that the error message when a

Overrides:

getInput in class DataObjectFactory<T extends Classification>

Parameters:

fil - BaseFilter for suggested values

restrict - boolean should filter restrict results

Returns:

addToHistorySpecification

public void addToHistorySpecification(TableSpecification spec)

Description copied from interface: HistoryFieldContributor

add fields to the history table default specification.

Specified by:

addToHistorySpecification in interface HistoryFieldContributor