org.melati.poem
Class ExtraColumn

java.lang.Object
  org.melati.poem.Column
      org.melati.poem.ExtraColumn

All Implemented Interfaces:

FieldAttributes

public class ExtraColumn
extends Column

A Column which exists in the dbms but is not defined in the DSD.

Nested Class Summary

Nested classes/interfaces inherited from class org.melati.poem.Column

Column.LoadException, Column.SettingException

Constructor Summary

ExtraColumn(Table table, String name, SQLPoemType type, DefinitionSource definitionSource, int extrasIndex)
Constructor.

Method Summary

Field	asField(Persistent g) Return a Field of the same type as this Column from the Persistent.
static Column	from(Table table, ColumnInfo columnInfo, int extrasIndex, DefinitionSource source) Static factory.
Object	getCooked(Persistent g) Retrieves the field value, with locking and access control for this Column.
Object	getRaw_unsafe(Persistent g) Retrieves the field value, without locking, for this Column.
Object	getRaw(Persistent g) Retrieves the field value, with locking, for this Column.
void	setCooked(Persistent g, Object cooked) Sets the field value, with locking, access control and validation for this Column.
void	setRaw_unsafe(Persistent g, Object raw) Sets the field value, without locking, for this Column.
void	setRaw(Persistent g, Object raw) Sets the field value, with locking, for this Column.

Methods inherited from class org.melati.poem.Column

asEmptyField, cachedSelectionWhereEq, defaultDescription, defaultDisplayLevel, defaultDisplayName, defaultDisplayOrder, defaultDisplayOrderPriority, defaultHeight, defaultIndexed, defaultIntegrityFix, defaultPrecision, defaultRenderinfo, defaultScale, defaultSearchability, defaultSortDescending, defaultUnique, defaultUserCreateable, defaultUserEditable, defaultWidth, dump, dump, ensure, eqClause, firstFree, firstWhereEq, fullQuotedName, getColumnInfo, getDatabase, getDescription, getDisplayLevel, getDisplayName, getDisplayOrderPriority, getHeight, getIndexed, getIntegrityFix, getName, getRenderInfo, getSearchability, getSortDescending, getSQLType, getTable, getType, getUnique, getUserCreateable, getUserEditable, getWidth, isDeletedColumn, isTroidColumn, quotedName, referencesTo, selectionWhereEq, setDisplayLevel, setIntegrityFix, setRawString, setSearchability, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtraColumn

public ExtraColumn(Table table,
                   String name,
                   SQLPoemType type,
                   DefinitionSource definitionSource,
                   int extrasIndex)

Constructor.

Method Detail

getRaw

public Object getRaw(Persistent g)
              throws AccessPoemException

Retrieves the field value, with locking, for this Column.

Specified by:

getRaw in class Column

Parameters:

g - the Persistent to read

Returns:

the Object itself

Throws:

AccessPoemException - if the current AccessToken does not confer read access rights

See Also:

Column.getRaw(org.melati.poem.Persistent)

getRaw_unsafe

public Object getRaw_unsafe(Persistent g)

Retrieves the field value, without locking, for this Column.

Specified by:

getRaw_unsafe in class Column

Parameters:

g - the Persistent to read

Returns:

the Object without checks

See Also:

Column.getRaw_unsafe(org.melati.poem.Persistent)

setRaw

public void setRaw(Persistent g,
                   Object raw)
            throws AccessPoemException,
                   ValidationPoemException

Sets the field value, with locking, for this Column.

Specified by:

setRaw in class Column

Parameters:

g - the Persistent to modify

raw - the value to set the field to

Throws:

AccessPoemException - if the current AccessToken does not confer write access rights

ValidationPoemException - if the raw value is not valid

See Also:

Column.setRaw(org.melati.poem.Persistent, java.lang.Object)

setRaw_unsafe

public void setRaw_unsafe(Persistent g,
                          Object raw)

Sets the field value, without locking, for this Column.

Specified by:

setRaw_unsafe in class Column

Parameters:

g - the Persistent to modify

raw - the value to set the field to

See Also:

Column.setRaw_unsafe(org.melati.poem.Persistent, java.lang.Object)

getCooked

public Object getCooked(Persistent g)
                 throws AccessPoemException,
                        PoemException

Retrieves the field value, with locking and access control for this Column.

Specified by:

getCooked in class Column

Parameters:

g - the Persistent to modify

Returns:

either the value or what is represented by the value

Throws:

AccessPoemException - if the current AccessToken does not confer read access rights

PoemException - if any problem occurs

See Also:

Column.getCooked(org.melati.poem.Persistent)

setCooked

public void setCooked(Persistent g,
                      Object cooked)
               throws AccessPoemException,
                      ValidationPoemException

Sets the field value, with locking, access control and validation for this Column.

Specified by:

setCooked in class Column

Parameters:

g - the Persistent to modify

cooked - the value to set

Throws:

AccessPoemException - if the current AccessToken does not confer read access rights

ValidationPoemException - if the value is not valid

See Also:

Column.setCooked(org.melati.poem.Persistent, java.lang.Object)

asField

public Field asField(Persistent g)

Return a Field of the same type as this Column from the Persistent.

Specified by:

asField in class Column

Parameters:

g - the Persistent

Returns:

a Field

See Also:

Column.asField(org.melati.poem.Persistent)

from

public static Column from(Table table,
                          ColumnInfo columnInfo,
                          int extrasIndex,
                          DefinitionSource source)

Static factory.

Parameters:

table -

columnInfo -

extrasIndex -

source -

Returns:

a new ExtraColumn