uk.ac.ed.epcc.webapp.model.data.reference

Class IndexedReference<I extends Indexed>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.reference.IndexedReference<I>

Type Parameters:

I -

public final class IndexedReference<I extends Indexed>
extends java.lang.Object

A lightweight class that holds the id of an Indexed type and enough information to create the target object. This is intended to be as efficient as using and Integer object but with better type safety and the ability to retrieve the target directly. An id of zero always denotes an unknown value. Note that IndexedSQLValue will generate a IndexedReference with id of zero for a null reference We can't implement a sensible sort order (other than numeric) without an AppContext reference. It is therefore better not to implement Comparable as higher level code (such as table) can but will default to a Comparable implementation if it is implemented. If numeric sorting is required use a ReferenceComparator.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INDEXED_REFERENCE_NAME_REGEXP
static java.util.regex.Pattern	NAME_PATTERN

Constructor Summary

Constructors

Constructor and Description
IndexedReference(int id, java.lang.Class<? extends IndexedProducer> clazz)
IndexedReference(int id, java.lang.Class<? extends IndexedProducer> clazz, java.lang.String table)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Class<? extends IndexedProducer>	getFactoryClass()
int	getID()
I	getIndexed(AppContext c)
java.lang.String	getTag()
int	hashCode()
boolean	isNull() check reference points somewhere
static <I extends Indexed> IndexedProducer<I>	makeIndexedProducer(AppContext c, java.lang.Class<? extends IndexedProducer> clazz, java.lang.String table)
static <I extends Indexed> IndexedReference<I>	parseIndexedReference(AppContext c, java.lang.String s) parse the string value of an IndexedReference
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INDEXED_REFERENCE_NAME_REGEXP

public static final java.lang.String INDEXED_REFERENCE_NAME_REGEXP

See Also:

Constant Field Values

NAME_PATTERN

public static final java.util.regex.Pattern NAME_PATTERN

Constructor Detail

IndexedReference

public IndexedReference(int id,
                        java.lang.Class<? extends IndexedProducer> clazz,
                        java.lang.String table)

IndexedReference

public IndexedReference(int id,
                        java.lang.Class<? extends IndexedProducer> clazz)

Method Detail

getIndexed

public I getIndexed(AppContext c)

makeIndexedProducer

public static <I extends Indexed> IndexedProducer<I> makeIndexedProducer(AppContext c,
                                                                         java.lang.Class<? extends IndexedProducer> clazz,
                                                                         java.lang.String table)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getID

public int getID()

getFactoryClass

public java.lang.Class<? extends IndexedProducer> getFactoryClass()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isNull

public boolean isNull()

check reference points somewhere

Returns:

true if reference is unknown

parseIndexedReference

public static <I extends Indexed> IndexedReference<I> parseIndexedReference(AppContext c,
                                                                            java.lang.String s)

parse the string value of an IndexedReference

Type Parameters:

I - type referenced

Parameters:

c - AppContext

s - String to parse

Returns:

IndexedReference

getTag

public java.lang.String getTag()