uk.ac.ed.epcc.webapp.model.data.reference

Interface IndexedProducer<A extends Indexed>

Type Parameters:

A -

All Superinterfaces:

Targetted<A>, TypeConverter<A,java.lang.Number>

All Known Subinterfaces:

LogOwner<O>

All Known Implementing Classes:

AbstractMessageHandlerFactory, AbstractRelationship, AbstractRequestFactory, AbstractTargetRequestFactory, AbstractUserRequestFactory, AbstractUserSettingFactory, AppUserFactory, AppUserFactory.SignupFormCreator, AppUserUpdater, BadKeyFactory, BooleanDataManager, CachedIndexedProducer, ClassificationFactory, ClassificationFactory.ClassificationCreator, ClassificationFactory.ClassificationUpdater, CreateTransition, Creator, DataObjectDataProducer, DataObjectFactory, DataObjectFormFactory, DataObjectUpdateFormFactory, DataStore, DateDataManager, DynamicFormManager, DynamicFormTransitionProvider.Creator, EmailChangeRequestFactory, FileDataFactory, HandlerPartManager, HistoryFactory, IndexedLinkManager, IndexedLinkManager.LinkUpdater, IndexedTypeProducer, IntegerDataManager, LazyIndexProducer, LinkHistoryManager, LinkManager, LockFactory, LogFactory, MessageData.Factory, MultiLinkManager, MultiNameFactory, OptionDataManager, PageManager, PartConfigFactory, PartManager, PartManager.PartCreator, PartManager.PartUpdater, PartOwnerFactory, PasswordChangeRequestFactory, PersonalResponseManager, PersonHistoryFactory, PersonRelationship, PreferedViewFactory, PropertyFactory, QuestionManager, Relationship, RelationshipLinkManager, ResponseDataManager, ResponseManager, RoleUpdate, SectionManager, StreamDataDataManager, StringDataManager, TextDataFactory, TextFileOverlay, TextFileOverlay.TextFileCreator, Updater, UpdateTransition, UserSettingFactory, UserStringSettingFactory, WtmpManager, XMLOverlay

public interface IndexedProducer<A extends Indexed>
extends TypeConverter<A,java.lang.Number>

A factory interface for Indexed objects. Note that though Indexed objects can always be represented as integers we implement TypeConverter to convert from any Number. This is to preserve the flexibility to cope with database fields that return long values in preference to integers.

Method Summary

Modifier and Type	Method and Description
A	find(int id)
java.lang.String	getID(A obj) Generate the default text identifier of the client object for contexts where the type is unambiguous.
java.lang.Class<A>	getTarget() Get a class object that all results of the producer are assignable to.
boolean	isMyReference(IndexedReference ref) Test if an IndexedReference belongs to this producer.
IndexedReference<A>	makeReference(A obj) Make a IndexedReference from a target object
IndexedReference<A>	makeReference(int id) Make and IndexedReferencce from an integer id.

Methods inherited from interface uk.ac.ed.epcc.webapp.model.data.convert.TypeConverter

find, getIndex

Method Detail

find

A find(int id)
throws DataException

Throws:

DataException

getTarget

java.lang.Class<A> getTarget()

Get a class object that all results of the producer are assignable to. This is intended for run-time type checking so it should be as specific as possible

Specified by:

getTarget in interface Targetted<A extends Indexed>

Returns:

Class object for target

makeReference

IndexedReference<A> makeReference(A obj)

Make a IndexedReference from a target object

Parameters:

obj -

Returns:

IndexedReference

makeReference

IndexedReference<A> makeReference(int id)

Make and IndexedReferencce from an integer id.

Parameters:

id -

Returns:

IndexedReference

isMyReference

boolean isMyReference(IndexedReference ref)

Test if an IndexedReference belongs to this producer. This returns false for any null reference.

Parameters:

ref -

Returns:

boolean

getID

java.lang.String getID(A obj)

Generate the default text identifier of the client object for contexts where the type is unambiguous. This is used in urls and html inputs. Normally this should generate the String representation of the integer id. if it generates anything else the IndexedProducer should implement ParseFactory to be able to parse the alternative form.

Parameters:

obj -

Returns: