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

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.ManyToManyMapping

All Implemented Interfaces:

LoadSecondary, Relation, SecondaryTable, StoreSecondary

Direct Known Subclasses:

OrderedManyToManyMapping

public class ManyToManyMapping

extends AbstractCollectionMapping

implements Relation, LoadSecondary, StoreSecondary, SecondaryTable

Represents a M-M mapping with a persistent object type. M-M mappings are stored in a separate table from the primary values of the owning class. Each row of the table holds two values: a single PK value of the related object collection in the data column, and the PK value of the owning object in the ref 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.Relation

INVERSE, READ_ONLY

Constructor Summary

ManyToManyMapping()

Method Summary

protected void	addValueMatchCondition(SQLStatement sql, Object value, ClassResolver resolver) Add a WHERE [data cols] = [value] for the given object value to the given sql statement.
protected boolean	canMap(FieldMetaData fmd, ClassResolver resolver) Return true if this mapping type can handle the given field, false otherwise.
void	delete(StateManagerImpl sm, Object[] pks, int field, SQLExecutionManager sqlem) Delete the field from the secondary table for this mapping.
Object	getDataStoreValue(Object val, PersistenceManagerImpl pm) Translate the given field value to its datastore equivalent.
Column[]	getRelationPKColumns() Return the primary key column(s) of the related object.
Class	getRelationType() Return the type the mapping relates to.
Table	getSecondaryTable() Return the secondary table used by this mapping.
protected void	insert(Insert insert, Object value, int index, StateManagerImpl sm, Object[] pks, int field) Prepare the insert for storage.
void	insert(StateManagerImpl sm, Object[] pks, int field, SQLExecutionManager sqlem) Insert the given field into the secondary table for this mapping.
protected void	install(FieldMetaData fmd, JDBCConfiguration conf, ClassResolver resolver, DBDictionary dict) Setup this FieldMapping using the given metadata.
boolean	isReadOnly() Return true if this mapping has been set read only, and will not insert, update, or delete values.
protected static boolean	isReadOnly(FieldMetaData fmd, FieldMetaData imd)
void	join(ObjectSelect sel) Join this mapping to the given select statement.
void	joinRelation(Joins joins, PersistenceManagerImpl pm) Join this value's table to the table for the related first class object type, if any.
void	load(StateManagerImpl sm, Object[] pks, int field, SQLExecutionManager sqlem) Load the value of this mapping for the given instance.
protected void	select(ObjectSelect sel, StateManagerImpl sm, Object[] pks, int field)
void	setReadOnly(boolean ro) Set this mapping to be read-only.
void	setRelationPKColumns(Column[] val)
void	update(StateManagerImpl sm, Object[] pks, int field, SQLExecutionManager sqlem) Update the given field into the secondary table for this mapping.

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

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

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

addColumn, addPKColumns, getDataColumns, 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.Relation

getConfiguration

Constructor Detail

ManyToManyMapping

public ManyToManyMapping()

Method Detail

getRelationType

public Class getRelationType()

Description copied from interface: Relation

Return the type the mapping relates to.

Specified by:

getRelationType in interface Relation

getRelationPKColumns

public Column[] getRelationPKColumns()

Description copied from interface: Relation

Return the primary key column(s) of the related object.

Specified by:

getRelationPKColumns in interface Relation

setRelationPKColumns

public void setRelationPKColumns(Column[] val)

isReadOnly

public boolean isReadOnly()

Return true if this mapping has been set read only, and will not insert, update, or delete values.

setReadOnly

public void setReadOnly(boolean ro)

Set this mapping to be read-only. When two classes share a many-to-many table between them, one of the classes must mark their mapping read only to prevent duplicate inserts.

join

public void join(ObjectSelect sel)

Description copied from class: FieldMapping

Join this mapping to the given select statement. For basic mappings, this no-op method implementation will suffice. Secondary table mappings should override this method to do the proper join.

Overrides:

join in class FieldMapping

insert

public void insert(StateManagerImpl sm,
                   Object[] pks,
                   int field,
                   SQLExecutionManager sqlem)
            throws SQLException

Description copied from interface: StoreSecondary

Insert the given field into the secondary table for this mapping.

Specified by:

insert in interface StoreSecondary

Overrides:

insert in class AbstractCollectionMapping

update

public void update(StateManagerImpl sm,
                   Object[] pks,
                   int field,
                   SQLExecutionManager sqlem)
            throws SQLException

Description copied from interface: StoreSecondary

Update the given field into the secondary table for this mapping.

Specified by:

update in interface StoreSecondary

Overrides:

update in class AbstractCollectionMapping

delete

public void delete(StateManagerImpl sm,
                   Object[] pks,
                   int field,
                   SQLExecutionManager sqlem)
            throws SQLException

Description copied from interface: StoreSecondary

Delete the field from the secondary table for this mapping.

Specified by:

delete in interface StoreSecondary

Overrides:

delete in class AbstractCollectionMapping

load

public void load(StateManagerImpl sm,
                 Object[] pks,
                 int field,
                 SQLExecutionManager sqlem)
          throws SQLException

Description copied from interface: LoadSecondary

Load the value of this mapping for the given instance. Relations to other persistent types are loaded as PersistenceCapable instances.

Specified by:

load in interface LoadSecondary

Following copied from interface: com.solarmetric.kodo.impl.jdbc.ormapping.LoadSecondary

Parameters:

stmnt - The caller is responsible for closing the statement.

select

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

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 AbstractCollectionMapping

addValueMatchCondition

protected void addValueMatchCondition(SQLStatement sql,
                                      Object value,
                                      ClassResolver resolver)

Description copied from class: AbstractCollectionMapping

Add a WHERE [data cols] = [value] for the given object value to the given sql statement.

Overrides:

addValueMatchCondition in class AbstractCollectionMapping

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 AbstractCollectionMapping

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 AbstractCollectionMapping

isReadOnly

protected static boolean isReadOnly(FieldMetaData fmd,
                                    FieldMetaData imd)

getSecondaryTable

public Table getSecondaryTable()

Description copied from interface: SecondaryTable

Return the secondary table used by this mapping.

Specified by:

getSecondaryTable in interface SecondaryTable

getDataStoreValue

public Object getDataStoreValue(Object val,
                                PersistenceManagerImpl pm)

Description copied from class: FieldMapping

Translate the given field value to its datastore equivalent. If the mapping occupies multiple columns in the datastore, return an object array, else return a single object. Simply returns the given object by default.

Overrides:

getDataStoreValue in class FieldMapping

joinRelation

public void joinRelation(Joins joins,
                         PersistenceManagerImpl pm)

Description copied from class: FieldMapping

Join this value's table to the table for the related first class object type, if any.

Overrides:

joinRelation in class FieldMapping