uk.ac.ed.epcc.webapp.model

Class Classification

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.Classification

All Implemented Interfaces:

java.lang.Comparable<Classification>, java.security.Principal, Contexed, ContextIndexed, Identified, Indexed, Owned, Releasable

Direct Known Subclasses:

DataStore.Data, LockFactory.Lock, PreferedView

public class Classification
extends DataObject
implements java.security.Principal, java.lang.Comparable<Classification>, Owned

Classification is used to implement classification tables where objects are grouped into a finite set of categories defined in a database table. This is so common that its worth having a utility class to save on boilerplate code.

This class can be used directly (passing the table name to the constructor) or it can be subclassed to improve type safety and specify a default table.

The name value should be unique within the table. Table entries rarely change and may be populated manually.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTION
protected ClassificationFactory	fac
static java.lang.String	NAME
static java.lang.String	SORT_ORDER

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

DEBUG, record

Fields inherited from interface uk.ac.ed.epcc.webapp.forms.Identified

MAX_IDENTIFIER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Classification(Repository.Record res, ClassificationFactory fac)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Classification o)
java.lang.String	getDescription()
ClassificationFactory	getFactory()
java.lang.String	getIdentifier(int max_length) Generate Identifier with advisory max length.
java.lang.String	getName()
static TableSpecification	getTableSpecification(AppContext c, java.lang.String table) Generate a default TableSpecification for a Classification table
protected void	post_commit(boolean changed) Extension point called at end of commit
void	setDescription(java.lang.String desc)
void	setName(java.lang.String name)
java.lang.String	toString()

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

addToMap, addToMap, addToMap, commit, delete, empty, equals, formUpdate, getContext, getDatabaseService, getFactoryTag, getID, getIdentifier, getLogger, getMap, getMap, getOwningFactory, getRecord, getRecord, getRecord, getSQLContext, getUniqueIdName, hashCode, isLocked, lock, postCreate, pre_commit, release, setContents, setDirty, setMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

equals, hashCode, implies

Field Detail

SORT_ORDER

public static final java.lang.String SORT_ORDER

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

fac

protected ClassificationFactory fac

Constructor Detail

Classification

protected Classification(Repository.Record res,
                         ClassificationFactory fac)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface java.security.Principal

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String desc)

getIdentifier

public java.lang.String getIdentifier(int max_length)

Description copied from interface: Identified

Generate Identifier with advisory max length.

Specified by:

getIdentifier in interface Identified

Overrides:

getIdentifier in class DataObject

Parameters:

max_length - advisory max length

Returns:

String identifier

toString

public java.lang.String toString()

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class DataObject

getTableSpecification

public static TableSpecification getTableSpecification(AppContext c,
                                                       java.lang.String table)

Generate a default TableSpecification for a Classification table

Parameters:

c -

Returns:

TableSpecification

compareTo

public int compareTo(Classification o)

Specified by:

compareTo in interface java.lang.Comparable<Classification>

post_commit

protected void post_commit(boolean changed)
                    throws DataFault

Description copied from class: DataObject

Extension point called at end of commit

Overrides:

post_commit in class DataObject

Parameters:

changed - record was changed by commit.

Throws:

DataFault

getFactory

public final ClassificationFactory getFactory()

Specified by:

getFactory in interface Owned