uk.ac.ed.epcc.webapp.model

Interface NameFinder<T extends DataObject>

Type Parameters:

T -

All Superinterfaces:

ParseFactory<T>

All Known Subinterfaces:

NameInputProvider<X>

All Known Implementing Classes:

AppUserFactory, ClassificationFactory, DataStore, LockFactory, MultiNameFactory, PreferedViewFactory

public interface NameFinder<T extends DataObject>
extends ParseFactory<T>

Interface for factory classes that can look-up or create an entry by name. This extends ParseFactory but is specific to DataObjects rather than general Indexeds.

Method Summary

Modifier and Type	Method and Description
T	findFromString(java.lang.String name) Find an existing entry by name This should use the same logic as getStringFinderFilter(String).
DataCache<java.lang.String,T>	getDataCache() get a DataCache for fetching the target
SQLFilter<T>	getStringFinderFilter(java.lang.String name) get a filter than locates the target object from a String.
T	makeFromString(java.lang.String name) Same as findFromString(String) but attempts to create a matching entry if one does not exist and this is supported by the implementing class.
void	validateNameFormat(java.lang.String name) Check formatting constraints on the input string.

Methods inherited from interface uk.ac.ed.epcc.webapp.model.ParseFactory

getCanonicalName

Method Detail

validateNameFormat

void validateNameFormat(java.lang.String name)
                 throws ParseException

Check formatting constraints on the input string.

Parameters:

name -

Throws:

ParseException

findFromString

T findFromString(java.lang.String name)

Find an existing entry by name This should use the same logic as getStringFinderFilter(String).

Specified by:

findFromString in interface ParseFactory<T extends DataObject>

Parameters:

name -

Returns:

Matching T or null

makeFromString

T makeFromString(java.lang.String name)
          throws DataFault,
                 ParseException

Same as findFromString(String) but attempts to create a matching entry if one does not exist and this is supported by the implementing class.

Parameters:

name -

Returns:

T or null

Throws:

DataFault

ParseException

getStringFinderFilter

SQLFilter<T> getStringFinderFilter(java.lang.String name)

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

Parameters:

name -

Returns:

getDataCache

DataCache<java.lang.String,T> getDataCache()

get a DataCache for fetching the target

Returns:

DataCache