org.liquidsite.core.data
Class AbstractData.Parameter

java.lang.Object
  org.liquidsite.core.data.AbstractData.Parameter

Direct Known Subclasses:

AbstractData.BooleanParameter, AbstractData.DateParameter, AbstractData.IntegerParameter, AbstractData.LongParameter, AbstractData.StringParameter

Enclosing class:

AbstractData

protected abstract static class AbstractData.Parameter

extends java.lang.Object

A data object parameter. A parameter corresponds to a column in the database table.

Constructor Summary

protected

AbstractData.Parameter(java.lang.Class dataClass, java.lang.String column) Creates a new parameter.

Method Summary

java.lang.String	getColumn() Returns the parameter column name.
abstract void	initialize(AbstractData data) Initializes a data object with the default value for this parameter.
abstract void	transfer(DatabaseResults.Row row, AbstractData data) Transfers this parameter from a database row to a data object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractData.Parameter

protected AbstractData.Parameter(java.lang.Class dataClass,
                                 java.lang.String column)

Creates a new parameter. The new parameter will be added to the corresponding parameter set in the set of all data object parameters. If no parameter set exists for the data object class, a new parameter set will be created.

Parameters:

dataClass - the data object class

column - the column name

Method Detail

getColumn

public java.lang.String getColumn()

Returns the parameter column name.

Returns:

the parameter column name

initialize

public abstract void initialize(AbstractData data)

Initializes a data object with the default value for this parameter.

Parameters:

data - the data object

transfer

public abstract void transfer(DatabaseResults.Row row,
                              AbstractData data)
                       throws DatabaseDataException

Transfers this parameter from a database row to a data object.

Parameters:

row - the database row

data - the data object

Throws:

DatabaseDataException - if the database row contained malformed data