MultiLinkManager

java.lang.Object
- uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<M>
- - uk.ac.ed.epcc.webapp.model.data.MultiLinkManager<M>

Type Parameters:

M - type of MultiLink object

All Implemented Interfaces:

Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<M>, FilterMatcher<M>, TypeConverter<M,java.lang.Number>, DataObjectSelector<M>, Selector<DataObjectItemInput<M>>, Owner<M>, IndexedProducer<M>, Tagged, Targetted<M>
```
public abstract class MultiLinkManager<M extends MultiLinkManager.MultiLink>
extends DataObjectFactory<M>
```
MultiLinkManager is a superclass for handling Linkage objects that link multiple tables. This is more general that the 2-way LinkManager but harder to use as a result, instead of specifying right and left peers as method arguments you need to construct a Template and set the peer classes in the Template This class could implement auto_history and the join optimisations used by LinkManager but currently does not.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MultiLinkManager.MultiLink`
`class`	`MultiLinkManager.Template` Template is a class that specified the peer objects to be used when making a selection

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.DataObjectFactory
  AUTO_CREATE_TABLES_FEATURE, COMPOSITES_SUFFIX, REJECT_MULTIPLE_RESULT_FEATURE, res

Constructor Summary

Constructors
Modifier Constructor and Description

protected MultiLinkManager()
Basic Constructor subclasses should call addFactory to configure then call setContext

Constructors
Modifier	Constructor and Description
`protected`	`MultiLinkManager()` Basic Constructor subclasses should call addFactory to configure then call setContext

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addFactory(java.lang.String key, DataObjectFactory fac)` Method for sub-class to specify a link field and Factory.
`TableSpecification`	`getDefaultTableSpecification(AppContext ctx, java.lang.String homeTable)` Get the default table specification if the table is to be created.
`<R extends DataObject> BaseFilter<R>`	`getDestFilter(DataObjectFactory<R> fac, BaseFilter<M> fil)` Get a `BaseFilter` on one of the linked `DataObjectFactory`s
`java.util.Iterator<M>`	`getIterator(MultiLinkManager.Template t)` get an iterator over all MultiLinks matching the specified tempalte
`M`	`getLink(MultiLinkManager.Template t)` Find a MultiLink object corresponding to a complete Tempalte
`<R extends DataObject> BaseFilter<M>`	`getRemoteFilter(DataObjectFactory<R> fac, BaseFilter<R> fil)` get a `BaseFilter` on the `MultiLinkManager.MultiLink` from a filter on a remote `DataObjectFactory`
`FilterResult<M>`	`getResult(MultiLinkManager.Template t)`
`java.lang.Class<M>`	`getTarget()` Get a bound on the type of object produced by this factory for run-time checking.
`M`	`makeLink(MultiLinkManager.Template t)` Find a MultiLink or create it, if it does not exist.

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory
all, allowPreSelect, canCreate, 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, getFormUpdate, getID, getIndex, getInput, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOptional, getOrder, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getSelectors, getSupress, getTableSpecification, getTableStructureContributers, getTag, getTranslations, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, 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

- Constructor Detail
  - MultiLinkManager
```
protected MultiLinkManager()
```
    Basic Constructor subclasses should call addFactory to configure then call setContext
    
    Parameters:
    
    c -
- Method Detail
  - getDefaultTableSpecification
```
public TableSpecification getDefaultTableSpecification(AppContext ctx,
                                                       java.lang.String homeTable)
```
    Description copied from class: DataObjectFactory
    
    Get the default table specification if the table is to be created. A null result means that a default specification is not available and the table will not be created.
    
    Overrides:
    
    getDefaultTableSpecification in class DataObjectFactory<M extends MultiLinkManager.MultiLink>
    
    Parameters:
    
    ctx - AppContext
    
    homeTable - String table name.
    
    Returns:
    
    null or TableSpecification
  - addFactory
```
protected void addFactory(java.lang.String key,
                          DataObjectFactory fac)
```
    Method for sub-class to specify a link field and Factory. Normally called within the sub-class constructor
    
    Parameters:
    
    key -
    
    fac -
  - getIterator
```
public java.util.Iterator<M> getIterator(MultiLinkManager.Template t)
                                  throws DataFault
```
    get an iterator over all MultiLinks matching the specified tempalte
    
    Parameters:
    
    t - Template
    
    Returns:
    
    Iterator
    
    Throws:
    
    DataFault
  - getResult
```
public FilterResult<M> getResult(MultiLinkManager.Template t)
                          throws DataFault
```
    Throws:
    
    DataFault
  - getLink
```
public M getLink(MultiLinkManager.Template t)
          throws DataException
```
    Find a MultiLink object corresponding to a complete Tempalte
    
    Parameters:
    
    t - Template
    
    Returns:
    
    MultiLink or null if it does not exist
    
    Throws:
    
    DataException
  - makeLink
```
public M makeLink(MultiLinkManager.Template t)
           throws DataException
```
    Find a MultiLink or create it, if it does not exist.
    
    Parameters:
    
    t -
    
    Returns:
    
    MultiLink
    
    Throws:
    
    DataException
  - getTarget
```
public java.lang.Class<M> getTarget()
```
    Description copied from class: DataObjectFactory
    
    Get a bound on the type of object produced by this factory for run-time checking. This implements IndexedProducer.getTarget(). Normally this method should be overridden each time we make a sub-class that narrows the produced type. However checks should still pass if the super-type method is retained.
    
    Specified by:
    
    getTarget in interface IndexedProducer<M extends MultiLinkManager.MultiLink>
    
    Specified by:
    
    getTarget in interface Targetted<M extends MultiLinkManager.MultiLink>
    
    Overrides:
    
    getTarget in class DataObjectFactory<M extends MultiLinkManager.MultiLink>
    
    Returns:
    
    Class object for return type
  - getDestFilter
```
public <R extends DataObject> BaseFilter<R> getDestFilter(DataObjectFactory<R> fac,
                                                          BaseFilter<M> fil)
                                                   throws InvalidArgument
```
    Get a BaseFilter on one of the linked DataObjectFactorys
    
    Type Parameters:
    
    R -
    
    Parameters:
    
    fac -
    
    fil -
    
    Returns:
    
    Throws:
    
    InvalidArgument
  - getRemoteFilter
```
public <R extends DataObject> BaseFilter<M> getRemoteFilter(DataObjectFactory<R> fac,
                                                            BaseFilter<R> fil)
                                                     throws InvalidArgument
```
    get a BaseFilter on the MultiLinkManager.MultiLink from a filter on a remote DataObjectFactory
    
    Type Parameters:
    
    R -
    
    Parameters:
    
    fac -
    
    fil -
    
    Returns:
    
    Throws:
    
    InvalidArgument

Class MultiLinkManager<M extends MultiLinkManager.MultiLink>

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

MultiLinkManager

Method Detail

getDefaultTableSpecification

addFactory

getIterator

getResult

getLink

makeLink

getTarget

getDestFilter

getRemoteFilter