JDBCCMPFieldBridge

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.ejb.plugins.cmp.jdbc.bridge
Interface JDBCCMPFieldBridge

All Superinterfaces:: CMPFieldBridge (src) , FieldBridge (src) , JDBCFieldBridge (src)

All Known Implementing Classes:: JDBCAbstractCMPFieldBridge (src)

public interface JDBCCMPFieldBridge
extends JDBCFieldBridge (src) , CMPFieldBridge (src)

JDBCCMPFieldBridge represents one CMP field. This implementations of this interface handles setting are responsible for setting statement parameters and loading results for instance values and primary keys. Life-cycle: Tied to the EntityBridge. Multiplicity: One for each entity bean cmp field.

Method Summary
`void`	`addDefaultFlag(byte flag)` TODO: Get rid of it
`byte`	`getDefaultFlags()` Returns the default field flags.
`java.lang.Object`	`getLockedValue(EntityEnterpriseContext (src) ctx)`
`java.lang.reflect.Field`	`getPrimaryKeyField()` Gets the field of the primary key object in which the value of this field is stored.
`java.lang.Object`	`getPrimaryKeyValue(java.lang.Object primaryKey)` Gets the value of this field in the specified primaryKey object.
`int`	`getTableIndex()` The index of the field among the table fields.
`boolean`	`isRelationTableField()`
`int`	`loadPrimaryKeyResults(java.sql.ResultSet rs, int parameterIndex, java.lang.Object[] pkRef)` Loads the data from result set into the primary key object.
`void`	`lockInstanceValue(EntityEnterpriseContext (src) ctx)` Optimistically locks field value.
`int`	`setArgumentParameters(java.sql.PreparedStatement ps, int parameterIndex, java.lang.Object arg)` Sets the prepared statement parameters with the data from the object.
`void`	`setLockingStrategy(LockingStrategy (src) lockingStrategy)`
`int`	`setPrimaryKeyParameters(java.sql.PreparedStatement ps, int parameterIndex, java.lang.Object primaryKey)` Sets the prepared statement parameters with the data from the primary key.
`java.lang.Object`	`setPrimaryKeyValue(java.lang.Object primaryKey, java.lang.Object value)` Sets the value of this field to the specified value in the specified primaryKey object.

Methods inherited from interface org.jboss.ejb.plugins.cmp.jdbc.bridge.JDBCFieldBridge (src)

getInstanceValue, getJDBCType, getManager, initInstance, isCMPField, isDirty, isLoaded, isPrimaryKeyMember, isReadOnly, isReadTimedOut, loadArgumentResults, loadInstanceResults, resetPersistenceContext, setClean, setInstanceParameters, setInstanceValue

Methods inherited from interface org.jboss.ejb.plugins.cmp.bridge.FieldBridge (src)

getFieldName, getValue, setValue

Methods inherited from interface org.jboss.ejb.plugins.cmp.bridge.CMPFieldBridge (src)

getFieldType

Method Detail

getTableIndex

public int getTableIndex()

The index of the field among the table fields.

getDefaultFlags

public byte getDefaultFlags()

Returns the default field flags.

addDefaultFlag

public void addDefaultFlag(byte flag)

TODO: Get rid of it

Parameters:: flag -

getLockedValue

public java.lang.Object getLockedValue(EntityEnterpriseContext (src)  ctx)

Parameters:: ctx - instance's context
Returns:: field value that was locked.

lockInstanceValue

public void lockInstanceValue(EntityEnterpriseContext (src)  ctx)

Optimistically locks field value.

setLockingStrategy

public void setLockingStrategy(LockingStrategy (src)  lockingStrategy)

Parameters:: lockingStrategy - locking strategy assigned to the field

getPrimaryKeyField

public java.lang.reflect.Field getPrimaryKeyField()

Gets the field of the primary key object in which the value of this field is stored.

getPrimaryKeyValue

public java.lang.Object getPrimaryKeyValue(java.lang.Object primaryKey)
                                    throws java.lang.IllegalArgumentException

Gets the value of this field in the specified primaryKey object.

Specified by:: getPrimaryKeyValue in interface JDBCFieldBridge (src)

Parameters:: primaryKey - the primary key object from which this fields value will be extracted
Returns:: the value of this field in the primaryKey object
Throws:: java.lang.IllegalArgumentException

isRelationTableField

public boolean isRelationTableField()

Returns:: true if the field belongs to a relation table

setPrimaryKeyValue

public java.lang.Object setPrimaryKeyValue(java.lang.Object primaryKey,
                                           java.lang.Object value)
                                    throws java.lang.IllegalArgumentException

Sets the value of this field to the specified value in the specified primaryKey object.

Parameters:: primaryKey - the primary key object which the value will be inserted; value - the value for field that will be set in the pk
Returns:: the updated primary key object; the actual object may change not just the value
Throws:: java.lang.IllegalArgumentException

setPrimaryKeyParameters

public int setPrimaryKeyParameters(java.sql.PreparedStatement ps,
                                   int parameterIndex,
                                   java.lang.Object primaryKey)
                            throws java.lang.IllegalArgumentException

Sets the prepared statement parameters with the data from the primary key.

Throws:: java.lang.IllegalArgumentException

setArgumentParameters

public int setArgumentParameters(java.sql.PreparedStatement ps,
                                 int parameterIndex,
                                 java.lang.Object arg)

Sets the prepared statement parameters with the data from the object. The object must be the type of this field.

loadPrimaryKeyResults

public int loadPrimaryKeyResults(java.sql.ResultSet rs,
                                 int parameterIndex,
                                 java.lang.Object[] pkRef)
                          throws java.lang.IllegalArgumentException

Loads the data from result set into the primary key object.