com.solarmetric.kodo.impl.jdbc.ormapping
Class OrderedCollectionMapping

java.lang.Object
  |
  +--com.solarmetric.kodo.impl.jdbc.ormapping.Mapping
        |
        +--com.solarmetric.kodo.impl.jdbc.ormapping.FieldMapping
              |
              +--com.solarmetric.kodo.impl.jdbc.ormapping.AbstractCollectionMapping
                    |
                    +--com.solarmetric.kodo.impl.jdbc.ormapping.CollectionMapping
                          |
                          +--com.solarmetric.kodo.impl.jdbc.ormapping.OrderedCollectionMapping

All Implemented Interfaces:

LoadSecondary, Ordered, SecondaryTable, StoreSecondary

public class OrderedCollectionMapping

extends CollectionMapping

implements Ordered

Represents an ordered collection of simple values such as Integers, Strings, etc. OrderedCollectionMappings are stored in a separate table from the primary values of the owning class. Each row of the table holds three values: a single element of the collection in the data column, the PK value of the owning object in the ref column, and the placement of the value in the collection in the order column.

Fields inherited from class com.solarmetric.kodo.impl.jdbc.ormapping.AbstractCollectionMapping

REF_COL

Fields inherited from class com.solarmetric.kodo.impl.jdbc.ormapping.FieldMapping

COL_INDEX, COL_LENGTH, DATA_COL, EMPTY_COLUMNS

Fields inherited from class com.solarmetric.kodo.impl.jdbc.ormapping.Mapping

_loc, _log, CUSTOM_MAPPING, dict, MAPPING, TABLE

Fields inherited from interface com.solarmetric.kodo.impl.jdbc.ormapping.Ordered

ORDER_COL, ORDERED

Constructor Summary

OrderedCollectionMapping()

Method Summary

protected boolean	canMap(FieldMetaData fmd, ClassResolver resolver) Return true if this mapping type can handle the given field, false otherwise.
Column	getOrderColumn() Return the column of the table this Collection is stored in which holds the ordering of the value of the Collection.
protected void	insert(Insert insert, Object value, int index, StateManagerImpl sm, Object[] pks, int field) Prepare the insert for storage.
protected void	install(FieldMetaData fmd, JDBCConfiguration conf, ClassResolver resolver, DBDictionary dict) Setup this FieldMapping using the given metadata.
protected void	select(Select sel, StateManagerImpl sm, Object[] pks, int field)
void	setOrderColumn(Column val) Set the column of the table this Collection is stored in which holds the order of this value in the Collection.

Methods inherited from class com.solarmetric.kodo.impl.jdbc.ormapping.CollectionMapping

addValueMatchCondition, getSecondaryTable, join, joinRelation, load

Methods inherited from class com.solarmetric.kodo.impl.jdbc.ormapping.AbstractCollectionMapping

appendIsEmpty, appendIsNotNull, appendIsNull, compareToNull, delete, fromArray, getInverse, getKeyColumns, getPKColumns, getRefColumns, insert, join, joinKey, joinKeyRelation, select, setPKColumns, setRefColumns, toArray, update

Methods inherited from class com.solarmetric.kodo.impl.jdbc.ormapping.FieldMapping

addColumn, addPKColumns, getDataColumns, getDataStoreValue, getInstance, getInstance, getKeyDataStoreValue, getMetaData, setDataColumns

Methods inherited from class com.solarmetric.kodo.impl.jdbc.ormapping.Mapping

checkExtension, createMapping, createMapping, createMappings, createMappings, getClassName, getConfiguration, getDictionary, getFieldMapping, getInstance, getTable, install

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.solarmetric.kodo.impl.jdbc.ormapping.StoreSecondary

delete, insert, update

Constructor Detail

OrderedCollectionMapping

public OrderedCollectionMapping()

Method Detail

getOrderColumn

public Column getOrderColumn()

Return the column of the table this Collection is stored in which holds the ordering of the value of the Collection.

setOrderColumn

public void setOrderColumn(Column val)

Set the column of the table this Collection is stored in which holds the order of this value in the Collection.

select

protected void select(Select sel,
                      StateManagerImpl sm,
                      Object[] pks,
                      int field)

Overrides:

select in class CollectionMapping

insert

protected void insert(Insert insert,
                      Object value,
                      int index,
                      StateManagerImpl sm,
                      Object[] pks,
                      int field)

Description copied from class: AbstractCollectionMapping

Prepare the insert for storage. Throws exception by default.

Overrides:

insert in class CollectionMapping

canMap

protected boolean canMap(FieldMetaData fmd,
                         ClassResolver resolver)

Description copied from class: FieldMapping

Return true if this mapping type can handle the given field, false otherwise. Note that this method cannot rely on the existance of other Mappings, as it is used in bootstrapping.

Overrides:

canMap in class CollectionMapping

install

protected void install(FieldMetaData fmd,
                       JDBCConfiguration conf,
                       ClassResolver resolver,
                       DBDictionary dict)

Description copied from class: FieldMapping

Setup this FieldMapping using the given metadata. Note that this method cannot rely on the existance of other Mappings, as it it is used in bootstrapping. This base implementation installs the proper extensions onto the metadata only; subclasses must override to properly map the type.

Overrides:

install in class CollectionMapping