uk.ac.ed.epcc.webapp.session

Class FieldNameFinder<AU extends AppUser,F extends FieldNameFinder>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.Composite<AU,X>

uk.ac.ed.epcc.webapp.session.AppUserComposite<AU,X>

uk.ac.ed.epcc.webapp.session.AppUserNameFinder<AU,F>

uk.ac.ed.epcc.webapp.session.FieldNameFinder<AU,F>

All Implemented Interfaces:

Contexed, TableStructureContributer<AU>, HistoryFieldContributor, ParseFactory<AU>

Direct Known Subclasses:

GlobalNamePolicy, SecondaryNameFinder, TertiaryNameFinder, WebNameFinder

public class FieldNameFinder<AU extends AppUser,F extends FieldNameFinder>
extends AppUserNameFinder<AU,F>
implements HistoryFieldContributor

A generic AppUserNameFinder that stores the name in a database field. This composite can be used directly with the realm-name set from the construction tag of the composite. However only one composite of this exact type can exist in a factory so trivial sub-classes are needed to install more than one FieldNameFinder, Because WebNameFinder is already a sub-class you can install a FieldNameFinder and a WebNameFinder without problems. Configuration parameters:

• NameFinder.realm.field field name defaults to realm.
• NameFinder.realm.label label defaults to realm.
• NameFinder.realm.user_supplied Is name user supplied default false
• NameFinder.realm.user_visible Is name user visible default as user_supplied
• NameFinder.realm.length field width.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	PROPERTY_PREFIX

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

fac

Constructor Summary

Constructors

Constructor and Description
FieldNameFinder(AppUserFactory factory, java.lang.String realm)

Method Summary

Modifier and Type	Method and Description
boolean	active() Checks if sufficient database fields exist to use this AppUserNameFinder An inactive finder still modifies the table specification but won't be retreivable as a realm.
java.util.Set<java.lang.String>	addSuppress(java.util.Set<java.lang.String> suppress) generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.
void	addToHistorySpecification(TableSpecification spec) add fields to the history table default specification.
java.util.Map<java.lang.String,java.lang.String>	addTranslations(java.util.Map<java.lang.String,java.lang.String> translations) return a default set of translation between field names and text labels.
void	customiseForm(Form f) Extension hook to allow additional Form customisation generic to all types of Form (create and update) For example adding a FormValidator .
void	customiseUpdateForm(Form f, AU target, SessionService operator) Extension hook to allow additional Form customisation specific to the update of an existing object.
protected int	defaultFieldLength() default filed length when creating table.
java.lang.String	getCanonicalName(AU object) Get a canonical name of an object in a format that can be parsed by the ParseFactory.findFromString(String) method.
java.lang.String	getNameLabel() Get a user presented label asking for the login name of the supported type.
SQLFilter	getStringFinderFilter(java.lang.Class target, java.lang.String name) get a filter than locates the target object from a String.
TableSpecification	modifyDefaultTableSpecification(TableSpecification spec, java.lang.String table) Modify the TableSpecification of the target factory.
protected java.lang.String	normalizeName(java.lang.String name) If there are varient forms of the names this normalises the name to the form stored in the database
void	setName(AU user, java.lang.String name) Set the name of an object for this realm (If supported)
protected boolean	userSet()
boolean	userVisible() Is this a name we might expect the user to know or an internal generated id.

Methods inherited from class uk.ac.ed.epcc.webapp.session.AppUserNameFinder

findFromString, getAllNames, getDataCache, getRealm, getType, toString, validateName, verified

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

addDefaults, addFieldHelp, addOptional, addSelectors, getContext, getFactory, getLogger, getRecord, getRepository, postUpdate, preRegister, release

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

addFieldConstraints, addFormFields

Field Detail

PROPERTY_PREFIX

protected static final java.lang.String PROPERTY_PREFIX

See Also:

Constant Field Values

Constructor Detail

FieldNameFinder

public FieldNameFinder(AppUserFactory factory,
                       java.lang.String realm)

Parameters:

factory -

realm -

Method Detail

getCanonicalName

public java.lang.String getCanonicalName(AU 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<AU extends AppUser>

Returns:

The canonical name.

normalizeName

protected java.lang.String normalizeName(java.lang.String name)

If there are varient forms of the names this normalises the name to the form stored in the database

Parameters:

name -

Returns:

getNameLabel

public java.lang.String getNameLabel()

Description copied from class: AppUserNameFinder

Get a user presented label asking for the login name of the supported type. If this method returns null or an empty string then the finder may still be included in a user supplied lookup but will not be acknowledged in the form label.

Specified by:

getNameLabel in class AppUserNameFinder<AU extends AppUser,F extends FieldNameFinder>

Returns:

getStringFinderFilter

public SQLFilter getStringFinderFilter(java.lang.Class target,
                                       java.lang.String name)

Description copied from class: AppUserNameFinder

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

Specified by:

getStringFinderFilter in class AppUserNameFinder<AU extends AppUser,F extends FieldNameFinder>

Returns:

userVisible

public boolean userVisible()

Description copied from class: AppUserNameFinder

Is this a name we might expect the user to know or an internal generated id.

Overrides:

userVisible in class AppUserNameFinder<AU extends AppUser,F extends FieldNameFinder>

Returns:

modifyDefaultTableSpecification

public TableSpecification modifyDefaultTableSpecification(TableSpecification spec,
                                                          java.lang.String table)

Description copied from interface: TableStructureContributer

Modify the TableSpecification of the target factory.

Specified by:

modifyDefaultTableSpecification in interface TableStructureContributer<AU extends AppUser>

Overrides:

modifyDefaultTableSpecification in class Composite<AU extends AppUser,F extends FieldNameFinder>

Returns:

defaultFieldLength

protected int defaultFieldLength()

default filed length when creating table.

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

addTranslations

public java.util.Map<java.lang.String,java.lang.String> addTranslations(java.util.Map<java.lang.String,java.lang.String> translations)

Description copied from interface: TableStructureContributer

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.

Specified by:

addTranslations in interface TableStructureContributer<AU extends AppUser>

Overrides:

addTranslations in class Composite<AU extends AppUser,F extends FieldNameFinder>

Returns:

Map

addSuppress

public java.util.Set<java.lang.String> addSuppress(java.util.Set<java.lang.String> suppress)

Description copied from interface: TableStructureContributer

generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.

Specified by:

addSuppress in interface TableStructureContributer<AU extends AppUser>

Overrides:

addSuppress in class Composite<AU extends AppUser,F extends FieldNameFinder>

Returns:

Set of fields to suppress in forms.

userSet

protected boolean userSet()

customiseUpdateForm

public void customiseUpdateForm(Form f,
                                AU target,
                                SessionService operator)

Description copied from interface: TableStructureContributer

Extension hook to allow additional Form customisation specific to the update of an existing object. This can also add constraints based on the relationship of the operator to the object being updated. Logic that does not require an existing object can be added to TableStructureContributer.customiseForm(Form)

Specified by:

customiseUpdateForm in interface TableStructureContributer<AU extends AppUser>

Overrides:

customiseUpdateForm in class Composite<AU extends AppUser,F extends FieldNameFinder>

customiseForm

public void customiseForm(Form f)

Description copied from interface: TableStructureContributer

Extension hook to allow additional Form customisation generic to all types of Form (create and update) For example adding a FormValidator . Logic that requires an existing object can be added to TableStructureContributer.customiseUpdateForm(Form, DataObject, SessionService)

Specified by:

customiseForm in interface TableStructureContributer<AU extends AppUser>

Overrides:

customiseForm in class Composite<AU extends AppUser,F extends FieldNameFinder>

Parameters:

f - Form to modify

setName

public void setName(AU user,
                    java.lang.String name)

Description copied from class: AppUserNameFinder

Set the name of an object for this realm (If supported)

Specified by:

setName in class AppUserNameFinder<AU extends AppUser,F extends FieldNameFinder>

active

public boolean active()

Description copied from class: AppUserNameFinder

Checks if sufficient database fields exist to use this AppUserNameFinder An inactive finder still modifies the table specification but won't be retreivable as a realm.

Specified by:

active in class AppUserNameFinder<AU extends AppUser,F extends FieldNameFinder>

Returns: