uk.ac.ed.epcc.webapp.session

Class RealNameComposite<AU extends AppUser>

java.lang.Object

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

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

uk.ac.ed.epcc.webapp.session.RealNameComposite<AU>

All Implemented Interfaces:

Contexed, AnonymisingComposite<AU>, TableStructureContributer<AU>, HistoryFieldContributor, NameComposite<AU>, SortNameContributor<AU>

public class RealNameComposite<AU extends AppUser>
extends AppUserComposite<AU,RealNameComposite>
implements AnonymisingComposite<AU>, SortNameContributor<AU>, NameComposite<AU>, HistoryFieldContributor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIRSTNAME
static java.lang.String	INITIALS
static java.lang.String	LASTNAME
static java.lang.String	TITLE

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

fac

Constructor Summary

Constructors

Constructor and Description
RealNameComposite(AppUserFactory<AU> fac)

Method Summary

Modifier and Type	Method and Description
void	addEraseFields(java.util.Set<java.lang.String> fields) Add to the set of fields that contain PII data This can be used to generate an anonymising rule for history tables
java.util.Set<java.lang.String>	addOptional(java.util.Set<java.lang.String> optional) generate the set of optional fields to be used to provide class specific defaults in form creation/update.
void	addOrder(java.util.List<OrderClause> order) Add OrderClause entries to the SQL default order
boolean	addSortName(AU target, java.lang.StringBuilder name) Add terms to the sorting name in the order consistent with the sorting order
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> labels) return a default set of translation between field names and text labels.
void	anonymise(AU target)
java.util.Comparator<AU>	getComparator() get a Comparator that compares target types according to the sort order
java.lang.String	getFirstname(AU target)
java.lang.String	getInitials(AU target)
java.lang.String	getLastname(AU target)
java.lang.String	getPresentationName(AU target) Get the presentation name
java.lang.String	getTitle(AU target)
protected java.lang.Class<? super RealNameComposite>	getType() Returns the type the composite should be registered under.
TableSpecification	modifyDefaultTableSpecification(TableSpecification spec, java.lang.String table) Modify the TableSpecification of the target factory.
void	setFirstName(AU target, java.lang.String first)
void	setInitials(AU target, java.lang.String initials)
void	setLastName(AU target, java.lang.String last)
void	setTitle(AU target, java.lang.String title)

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

addDefaults, addFieldHelp, addSelectors, addSuppress, customiseForm, customiseUpdateForm, getContext, getFactory, getLogger, getRecord, getRepository, postUpdate, preRegister, release, toString

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

TITLE

public static final java.lang.String TITLE

See Also:

Constant Field Values

FIRSTNAME

public static final java.lang.String FIRSTNAME

See Also:

Constant Field Values

INITIALS

public static final java.lang.String INITIALS

See Also:

Constant Field Values

LASTNAME

public static final java.lang.String LASTNAME

See Also:

Constant Field Values

Constructor Detail

RealNameComposite

public RealNameComposite(AppUserFactory<AU> fac)

Method Detail

getType

protected java.lang.Class<? super RealNameComposite> getType()

Description copied from class: Composite

Returns the type the composite should be registered under.

Specified by:

getType in class Composite<AU extends AppUser,RealNameComposite>

Returns:

registration type

getLastname

public java.lang.String getLastname(AU target)

setFirstName

public void setFirstName(AU target,
                         java.lang.String first)

setLastName

public void setLastName(AU target,
                        java.lang.String last)

setInitials

public void setInitials(AU target,
                        java.lang.String initials)

getTitle

public java.lang.String getTitle(AU target)

setTitle

public void setTitle(AU target,
                     java.lang.String title)

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

Returns:

getInitials

public java.lang.String getInitials(AU target)

getFirstname

public java.lang.String getFirstname(AU target)

addTranslations

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

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

Returns:

Map

anonymise

public void anonymise(AU target)

Specified by:

anonymise in interface AnonymisingComposite<AU extends AppUser>

addOptional

public java.util.Set<java.lang.String> addOptional(java.util.Set<java.lang.String> optional)

Description copied from interface: TableStructureContributer

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.

Specified by:

addOptional in interface TableStructureContributer<AU extends AppUser>

Overrides:

addOptional in class Composite<AU extends AppUser,RealNameComposite>

Returns:

Set

addSortName

public boolean addSortName(AU target,
                           java.lang.StringBuilder name)

Description copied from interface: SortNameContributor

Add terms to the sorting name in the order consistent with the sorting order

Specified by:

addSortName in interface SortNameContributor<AU extends AppUser>

Returns:

true if anything added.

addOrder

public void addOrder(java.util.List<OrderClause> order)

Description copied from interface: SortNameContributor

Add OrderClause entries to the SQL default order

Specified by:

addOrder in interface SortNameContributor<AU extends AppUser>

getComparator

public java.util.Comparator<AU> getComparator()

Description copied from interface: SortNameContributor

get a Comparator that compares target types according to the sort order

Specified by:

getComparator in interface SortNameContributor<AU extends AppUser>

Returns:

getPresentationName

public java.lang.String getPresentationName(AU target)

Description copied from interface: NameComposite

Get the presentation name

Specified by:

getPresentationName in interface NameComposite<AU extends AppUser>

Returns:

name or null

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

addEraseFields

public void addEraseFields(java.util.Set<java.lang.String> fields)

Description copied from interface: AnonymisingComposite

Add to the set of fields that contain PII data This can be used to generate an anonymising rule for history tables

Specified by:

addEraseFields in interface AnonymisingComposite<AU extends AppUser>