uk.ac.ed.epcc.webapp.model.relationship

Class Relationship<A extends AppUser,B extends DataObject>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.data.IndexedLinkManager<T,L,R>

uk.ac.ed.epcc.webapp.model.data.LinkManager<L,A,B>

uk.ac.ed.epcc.webapp.model.relationship.RelationshipLinkManager<A,B,L>

uk.ac.ed.epcc.webapp.model.relationship.AbstractRelationship<A,B,Relationship.Link<A,B>>

uk.ac.ed.epcc.webapp.model.relationship.Relationship<A,B>

Type Parameters:

A -

B -

All Implemented Interfaces:

Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<Relationship.Link<A,B>>, FilterMatcher<Relationship.Link<A,B>>, TableContentProvider, TypeConverter<Relationship.Link<A,B>,java.lang.Number>, DataObjectSelector<Relationship.Link<A,B>>, Selector<DataObjectItemInput<Relationship.Link<A,B>>>, Owner<Relationship.Link<A,B>>, IndexedProducer<Relationship.Link<A,B>>, AccessRoleProvider<A,B>, RelationshipProvider<A,B>, Tagged, Targetted<Relationship.Link<A,B>>

Direct Known Subclasses:

PersonRelationship

public class Relationship<A extends AppUser,B extends DataObject>
extends AbstractRelationship<A,B,Relationship.Link<A,B>>
implements TableContentProvider

Link class that encodes a relationship between an AppUser and a domain object. Possible roles are encoded as boolean fields in the table. Unless overridden in a sub-class. If the table is auto_created the initial set of roles are set in relationship.table.create_roles as a comma separated list. The property reference.table.TargetID must be set to the config tag of the domain object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Relationship.Link<A extends AppUser,B extends DataObject>

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.LinkManager

LinkManager.JoinLinkFilterIterator, LinkManager.JoinLinkMapper, LinkManager.LeftAcceptFilter, LinkManager.LinkInput, LinkManager.LinkResult, LinkManager.RightAcceptFilter

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.IndexedLinkManager

IndexedLinkManager.LinkFilter, IndexedLinkManager.LinkProvider<T extends IndexedLinkManager.Link<L,R>,L extends Indexed,R extends Indexed>, IndexedLinkManager.LinkUpdater, IndexedLinkManager.SQLLinkFilter

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.LinkManager

USE_JOIN

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

Modifier	Constructor and Description
	Relationship(AppContext c, java.lang.String tag)
protected	Relationship(AppContext c, java.lang.String tag, DataObjectFactory<B> target_fac) Constructor to allow sub-classes to set factory
protected	Relationship(AppContext c, java.lang.String tag, DataObjectFactory<B> b_fac, java.lang.String field) Extension constructor to allow sub-classes to set factory and field

Method Summary

Modifier and Type	Method and Description
void	addSummaryContent(ContentBuilder cb)
protected java.lang.String[]	getDefaultRoles(AppContext c, java.lang.String table) generate a list of the default roles to create when bootstrapping a table.
protected TableSpecification	getDefaultTableSpecification(AppContext c, java.lang.String table, IndexedProducer<A> leftFac, java.lang.String leftField, IndexedProducer<B> rightFac, java.lang.String rightField)
protected SQLFilter<Relationship.Link<A,B>>	getFilterFromRole(java.lang.String role) get a filter corresponding to the role.
static java.lang.String	getReferenceProp(java.lang.String tag)
java.util.Set<java.lang.String>	getRelationships() Get the set of relationships supported by this type.
protected Relationship.Link<A,B>	makeBDO(Repository.Record res) Construct a new Blank DataObject of the correct Class This method takes a Record as an argument.
static void	makeTable(AppContext conn, java.lang.String my_table, java.lang.String peer_table)

Methods inherited from class uk.ac.ed.epcc.webapp.model.relationship.AbstractRelationship

canCreate, hasRole, selectLink, setRole

Methods inherited from class uk.ac.ed.epcc.webapp.model.relationship.RelationshipLinkManager

addRelationships, getTargetFactory, getTargetFilter, getTargetRoleFilter, getUserFilter, getUserFilter, getUserRoleFilter, hasRelationFilter, personInRelationFilter, providesRelationship

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

find, find, getFilter, getFilterResult, getInput, getLeftFactory, getLeftFilter, getLeftFilter, getLeftInput, getLeftJoinFilter, getLeftRemoteFilter, getLinkCount, getLinkIterator, getRightFactory, getRightFilter, getRightFilter, getRightInput, getRightJoinFilter, getRightRemoteFilter, getSelectors, getTarget, isLeft, isRight

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

addLeftSet, addRightSet, getDefaultTableSpecification, getFinalTableSpecification, getFormUpdate, getHistoryHandler, getLeftField, getLeftFilter, getLeftProducer, getLeftSet, getLink, getRightField, getRightFilter, getRightProducer, getRightSet, getTableSpecification, makeHistoryHandler, makeLink, modifyHistoryTable, setContext, setHistoryHandler, updateHistory, useAutoHistory

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

all, allowPreSelect, 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, getID, getIndex, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOptional, getOrder, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getSupress, 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

Methods inherited from interface uk.ac.ed.epcc.webapp.Tagged

getTag

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Constructor Detail

Relationship

public Relationship(AppContext c,
                    java.lang.String tag)

Relationship

protected Relationship(AppContext c,
                       java.lang.String tag,
                       DataObjectFactory<B> b_fac,
                       java.lang.String field)

Extension constructor to allow sub-classes to set factory and field

Relationship

protected Relationship(AppContext c,
                       java.lang.String tag,
                       DataObjectFactory<B> target_fac)

Constructor to allow sub-classes to set factory

Parameters:

c -

tag -

target_fac -

Method Detail

getReferenceProp

public static java.lang.String getReferenceProp(java.lang.String tag)

getDefaultTableSpecification

protected TableSpecification getDefaultTableSpecification(AppContext c,
                                                          java.lang.String table,
                                                          IndexedProducer<A> leftFac,
                                                          java.lang.String leftField,
                                                          IndexedProducer<B> rightFac,
                                                          java.lang.String rightField)

Overrides:

getDefaultTableSpecification in class LinkManager<Relationship.Link<A extends AppUser,B extends DataObject>,A extends AppUser,B extends DataObject>

getDefaultRoles

protected java.lang.String[] getDefaultRoles(AppContext c,
                                             java.lang.String table)

generate a list of the default roles to create when bootstrapping a table.

Parameters:

c -

table -

Returns:

makeBDO

protected Relationship.Link<A,B> 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<Relationship.Link<A extends AppUser,B extends DataObject>>

Parameters:

res - Record to create object from

Returns:

new object of correct class.

Throws:

DataFault

getFilterFromRole

protected SQLFilter<Relationship.Link<A,B>> getFilterFromRole(java.lang.String role)
                                                       throws UnknownRelationshipException

Description copied from class: RelationshipLinkManager

get a filter corresponding to the role.

Specified by:

getFilterFromRole in class RelationshipLinkManager<A extends AppUser,B extends DataObject,Relationship.Link<A extends AppUser,B extends DataObject>>

Parameters:

role -

Returns:

Throws:

UnknownRelationshipException

makeTable

public static void makeTable(AppContext conn,
                             java.lang.String my_table,
                             java.lang.String peer_table)
                      throws DataFault

Throws:

DataFault

getRelationships

public java.util.Set<java.lang.String> getRelationships()

Description copied from interface: RelationshipProvider

Get the set of relationships supported by this type.

Specified by:

getRelationships in interface RelationshipProvider<A extends AppUser,B extends DataObject>

Returns:

Set

addSummaryContent

public void addSummaryContent(ContentBuilder cb)

Specified by:

addSummaryContent in interface TableContentProvider