org.objectweb.jorm.metainfo.api.rdb
Interface RDBValueMapping

All Superinterfaces:

MetaObject, java.io.Serializable, ValueMapping

All Known Implementing Classes:

BasicRDBValueMapping, BasicRDBValueMapping

public interface RDBValueMapping

extends ValueMapping

a RDBValueMapping defines all the columns which compose a value mapping.

Author:

X. Spengler

Method Summary

RDBColumnSpec	createRDBColumnSpec(java.lang.String columnName, java.lang.String type, boolean notNull) Creates a new RDBColumnSpec for the current RDBValueMapping object.
RDBColumnSpec	getRDBColumnSpec(java.lang.String columnName) Returns the RDBColumnSpec object corresponding to its name.
java.util.Iterator	iterateRDBColumnSpec() Allows to know all the RDBColumnSpec defined in the current RDBValueMapping object.

Methods inherited from interface org.objectweb.jorm.metainfo.api.ValueMapping

getMapperName, getMappingName

Methods inherited from interface org.objectweb.jorm.metainfo.api.MetaObject

getParent, setParent

Method Detail

createRDBColumnSpec

public RDBColumnSpec createRDBColumnSpec(java.lang.String columnName,
                                         java.lang.String type,
                                         boolean notNull)

Creates a new RDBColumnSpec for the current RDBValueMapping object. If the column already exists, it is returned.

Parameters:

columnName - the name of the column

type - the type of the column

notNull - true, if "notnull" is defined, else false

Returns:

a new RDBColumnSpec object or if the column already exists, it is returned

getRDBColumnSpec

public RDBColumnSpec getRDBColumnSpec(java.lang.String columnName)

Returns the RDBColumnSpec object corresponding to its name. If the column object does not exist, null is returned.

Parameters:

columnName - the name of the RDBColumnSpec object (column name)

Returns:

the corresponding RDBColumnSpec object or null if it does not exist

iterateRDBColumnSpec

public java.util.Iterator iterateRDBColumnSpec()

Allows to know all the RDBColumnSpec defined in the current RDBValueMapping object. If no object is defined, an empty iterator is returned. For the moment, only one element is returned. This iterator contains RDBColumnSpec objects.

Returns:

an iterator on RDBColumnSpec object