uk.ac.ed.epcc.webapp.session

Class MultiNameFinder<AU extends AppUser,X extends MultiNameFinder>

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

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

All Implemented Interfaces:

Contexed, TableStructureContributer<AU>, ParseFactory<AU>

public class MultiNameFinder<AU extends AppUser,X extends MultiNameFinder>
extends AppUserNameFinder<AU,X>

An AppUserNameFinder where multiple name mappings are held in a seperate table Configuration parameters:

• NameFinder.realm.label label defaults to realm.
• NameFinder.realm.table construction tag for a MultiNameFactory to hold the names

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
MultiNameFinder(AppUserFactory<AU> 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>	getAllNames(AU user) Get all of the defined names for this realm.
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<AU>	getStringFinderFilter(java.lang.Class<? super AU> target, java.lang.String name) get a filter than locates the target object from a String.
void	setName(AU user, java.lang.String name) Set the name of an object for this realm (If supported)

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

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

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

addDefaults, addFieldHelp, addOptional, addSelectors, addSuppress, addTranslations, customiseForm, customiseUpdateForm, getContext, getFactory, getLogger, getRecord, getRepository, modifyDefaultTableSpecification, 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

MultiNameFinder

public MultiNameFinder(AppUserFactory<AU> 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.

Returns:

The canonical name.

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,X extends MultiNameFinder>

Returns:

getStringFinderFilter

public SQLFilter<AU> getStringFinderFilter(java.lang.Class<? super AU> 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,X extends MultiNameFinder>

Returns:

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,X extends MultiNameFinder>

Returns:

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,X extends MultiNameFinder>

getAllNames

public java.util.Set<java.lang.String> getAllNames(AU user)

Description copied from class: AppUserNameFinder

Get all of the defined names for this realm. Defaults to just the canonical name.

Overrides:

getAllNames in class AppUserNameFinder<AU extends AppUser,X extends MultiNameFinder>

Returns:

Set