org.melati.poem
Class ValueInfo

java.lang.Object
  org.melati.poem.transaction.Transactioned
      org.melati.poem.JdbcPersistent
          org.melati.poem.generated.ValueInfoBase
              org.melati.poem.ValueInfo

All Implemented Interfaces:

Cloneable, Persistable, Persistent, Treeable

Direct Known Subclasses:

ColumnInfoBase, SettingBase

public class ValueInfo
extends ValueInfoBase

Abstract persistent generated from Poem.dsd and extended to cover Setting and ColumnInfo. Melati POEM generated, programmer modifiable stub for a Persistent ValueInfo object.

Field summary for SQL table ValueInfo
Name	Type	Description
displayname	String	A user-friendly name for the field
description	String	A brief description of the field's function
usereditable	Boolean	Whether it makes sense for the user to update the field's value
typefactory	PoemTypeFactory	The field's Melati type
nullable	Boolean	Whether the field can be empty
size	Integer	For character fields, the maximum number of characters that can be stored, (-1 for unlimited)
width	Integer	A sensible width for text boxes used for entering the field, where appropriate
height	Integer	A sensible height for text boxes used for entering the field, where appropriate
precision	Integer	Precision (total number of digits) for fixed-point numbers
scale	Integer	Scale (number of digits after the decimal) for fixed-point numbers
renderinfo	String	The name of the Melati templet (if not the default) to use for input controls for the field
rangelow_string	String	The low end of the range of permissible values for the field
rangelimit_string	String	The (exclusive) limit of the range of permissible values for the field

Generator

org.melati.poem.prepro.TableDef#generateMainJava

Field Summary

Fields inherited from class org.melati.poem.generated.ValueInfoBase

description, displayname, height, nullable, precision, rangelimit_string, rangelow_string, renderinfo, scale, size, typefactory, usereditable, width

Fields inherited from class org.melati.poem.transaction.Transactioned

valid

Constructor Summary

ValueInfo()
Constructor for a Persistent ValueInfo object.

Method Summary

FieldAttributes	fieldAttributesRenamedAs(FieldAttributes c)
Field	getRangelimit_stringField() Retrieves the Rangelimit_string value as a Field from this ValueInfo Persistent.
Field	getRangelow_stringField() Retrieves the Rangelow_string value as a Field from this ValueInfo Persistent.
SQLPoemType	getType() NOTE A type cannot be changed once initialised.
void	setRangelimit_string(String value) Sets the Rangelimit_string value, with checking, for this ValueInfo Persistent.
void	setRangelow_string(String value) Sets the Rangelow_string value, with checking, for this ValueInfo Persistent.
PoemTypeFactory.Parameter	toTypeParameter()

Methods inherited from class org.melati.poem.generated.ValueInfoBase

getDescription_unsafe, getDescription, getDescriptionField, getDisplayname_unsafe, getDisplayname, getDisplaynameField, getHeight_unsafe, getHeight, getHeightField, getNullable_unsafe, getNullable, getNullableField, getPoemDatabaseTables, getPrecision_unsafe, getPrecision, getPrecisionField, getRangelimit_string_unsafe, getRangelimit_string, getRangelow_string_unsafe, getRangelow_string, getRenderinfo_unsafe, getRenderinfo, getRenderinfoField, getScale_unsafe, getScale, getScaleField, getSize_unsafe, getSize, getSizeField, getTypefactory_unsafe, getTypefactory, getTypefactoryCode, getTypefactoryField, getUsereditable_unsafe, getUsereditable, getUsereditableField, getValueInfoTable, getWidth_unsafe, getWidth, getWidthField, setDescription_unsafe, setDescription, setDisplayname_unsafe, setDisplayname, setHeight_unsafe, setHeight, setHeight, setNullable_unsafe, setNullable, setNullable, setPrecision_unsafe, setPrecision, setPrecision, setRangelimit_string_unsafe, setRangelow_string_unsafe, setRenderinfo_unsafe, setRenderinfo, setScale_unsafe, setScale, setScale, setSize_unsafe, setSize, setSize, setTypefactory_unsafe, setTypefactory, setTypefactoryCode, setUsereditable_unsafe, setUsereditable, setUsereditable, setWidth_unsafe, setWidth, setWidth

Methods inherited from class org.melati.poem.JdbcPersistent

assertCanCreate, assertCanCreate, assertCanDelete, assertCanDelete, assertCanRead, assertCanRead, assertCanWrite, assertCanWrite, clone, commit, countMatchSQL, delete_unsafe, delete, delete, deleteAndCommit, deleteAndCommit, deleteLock, displayString, displayString, displayString, dump, dump, duplicated, duplicatedFloating, equals, existenceLock, existenceLock, fieldsOfColumns, fromClause, getCanDelete, getCanRead, getCanSelect, getCanWrite, getChildren, getCooked, getCookedString, getDatabase, getDetailDisplayFields, getField, getFields, getName, getPrimaryDisplayField, getRaw, getRawString, getReadable, getRecordDisplayFields, getSearchCriterionFields, getSummaryDisplayFields, getTable, getTroid, hashCode, invalidate, isDirty, load, makePersistent, postEdit, postInsert, postModify, postWrite, preEdit, readLock, readLock, readLock, rollback, setCooked, setDirty, setRaw, setRawString, statusExistent, statusNonexistent, toString, troid, upToDate, writeDown, writeLock, writeLock, writeLock

Methods inherited from class org.melati.poem.transaction.Transactioned

markValid, reset, setTransactionPool, transactionPool, unSee

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueInfo

public ValueInfo()

Constructor for a Persistent ValueInfo object.

Generator

org.melati.poem.prepro.TableDef#generateMainJava

Method Detail

toTypeParameter

public PoemTypeFactory.Parameter toTypeParameter()

Returns:

a Type Parameter based upon our size and nullability

getType

public SQLPoemType getType()

NOTE A type cannot be changed once initialised.

Returns:

our SQLPoemType

fieldAttributesRenamedAs

public FieldAttributes fieldAttributesRenamedAs(FieldAttributes c)

Parameters:

c - a FieldAttributes eg a Field

Returns:

a new FieldAttributes

getRangelow_stringField

public Field getRangelow_stringField()

Retrieves the Rangelow_string value as a Field from this ValueInfo Persistent.

Overrides:

getRangelow_stringField in class ValueInfoBase

Returns:

the String rangelow_string

See Also:

ValueInfoBase.getRangelow_stringField()

getRangelimit_stringField

public Field getRangelimit_stringField()

Retrieves the Rangelimit_string value as a Field from this ValueInfo Persistent.

Overrides:

getRangelimit_stringField in class ValueInfoBase

Returns:

the String rangelimit_string

See Also:

ValueInfoBase.getRangelimit_stringField()

setRangelow_string

public void setRangelow_string(String value)

Sets the Rangelow_string value, with checking, for this ValueInfo Persistent. Field description: The low end of the range of permissible values for the field

Overrides:

setRangelow_string in class ValueInfoBase

Parameters:

value - a validated int

See Also:

ValueInfoBase.setRangelow_string(java.lang.String)

setRangelimit_string

public void setRangelimit_string(String value)

Sets the Rangelimit_string value, with checking, for this ValueInfo Persistent. Field description: The (exclusive) limit of the range of permissible values for the field

Overrides:

setRangelimit_string in class ValueInfoBase

Parameters:

value - a validated int

See Also:

ValueInfoBase.setRangelimit_string(java.lang.String)