uk.ac.ed.epcc.webapp.session

Class MultiNameFactory<N extends MultiNameFactory.Name,AU extends AppUser>

java.lang.Object

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

uk.ac.ed.epcc.webapp.session.MultiNameFactory<N,AU>

All Implemented Interfaces:

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

public class MultiNameFactory<N extends MultiNameFactory.Name,AU extends AppUser>
extends DataObjectFactory<N>
implements NameFinder<N>

A factory for multi value AppUser names

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MultiNameFactory.Name

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

Constructor and Description
MultiNameFactory(AppContext conn, java.lang.String table)

Method Summary

Modifier and Type	Method and Description
N	findFromString(java.lang.String name) Find an existing entry by name This should use the same logic as NameFinder.getStringFinderFilter(String).
java.lang.String	getCanonicalName(N object) Get a canonical name of an object in a format that can be parsed by the ParseFactory.findFromString(String) method.
DataCache<java.lang.String,N>	getDataCache() get a DataCache for fetching the target
protected TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String table) Get the default table specification if the table is to be created.
java.util.Set<java.lang.String>	getNames(AU person)
SQLFilter<AU>	getPersonFilter(java.lang.String name)
SQLFilter<N>	getStringFinderFilter(java.lang.String name) get a filter than locates the target object from a String.
java.lang.Class<N>	getTarget() Get a bound on the type of object produced by this factory for run-time checking.
protected N	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.
N	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.
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, 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

MultiNameFactory

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

Method Detail

makeBDO

protected N 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<N extends MultiNameFactory.Name>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

getTarget

public java.lang.Class<N> 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<N extends MultiNameFactory.Name>

Specified by:

getTarget in interface Targetted<N extends MultiNameFactory.Name>

Overrides:

getTarget in class DataObjectFactory<N extends MultiNameFactory.Name>

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<N extends MultiNameFactory.Name>

Parameters:

c - AppContext

table - String table name.

Returns:

null or TableSpecification

getCanonicalName

public java.lang.String getCanonicalName(N 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<N extends MultiNameFactory.Name>

Returns:

The canonical name.

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<N extends MultiNameFactory.Name>

Throws:

ParseException

findFromString

public N 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<N extends MultiNameFactory.Name>

Specified by:

findFromString in interface ParseFactory<N extends MultiNameFactory.Name>

Returns:

Matching T or null

makeFromString

public N makeFromString(java.lang.String name)
                 throws DataFault,
                        ParseException

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<N extends MultiNameFactory.Name>

Returns:

T or null

Throws:

DataFault

ParseException

getStringFinderFilter

public SQLFilter<N> 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<N extends MultiNameFactory.Name>

Returns:

getPersonFilter

public SQLFilter<AU> getPersonFilter(java.lang.String name)

getNames

public java.util.Set<java.lang.String> getNames(AU person)

getDataCache

public DataCache<java.lang.String,N> getDataCache()

Description copied from interface: NameFinder

get a DataCache for fetching the target

Specified by:

getDataCache in interface NameFinder<N extends MultiNameFactory.Name>

Returns:

DataCache