Interface ITypeMapping
- All Known Implementing Classes:
AbstractTypeMapping,DelegatingTypeMapping
public interface ITypeMapping
Mapping of single values to and from the database.
- Since:
- 2.0
- Author:
- Eike Stepper, Stefan Winkler
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceA descriptor which describes one type mapping class.static interfaceA factory for typeMappings.static interfaceA provider for type mapping information.static interfaceA global (singleton) registry which collects all available type mappings which are either available in the CDO core, as declared extensions, or registered manually. -
Method Summary
Modifier and TypeMethodDescriptionvoidcreateDBField(org.eclipse.net4j.db.ddl.IDBTable table) Deprecated.voidcreateDBField(org.eclipse.net4j.db.ddl.IDBTable table, String fieldName) Creates the DBField and adds it to the given table.org.eclipse.net4j.db.DBTypeorg.eclipse.net4j.db.ddl.IDBFieldgetField()Read the value from aResultSetand convert it from the DB to the CDO representation.voidreadValueToRevision(ResultSet resultSet, InternalCDORevision revision) Read a value from aResultSet, convert it from the DB to the CDO representation and set it to the feature of the revision.voidsetDBField(org.eclipse.net4j.db.ddl.IDBTable table, String fieldName) Sets the DBField.voidsetDBType(org.eclipse.net4j.db.DBType dbType) voidsetDefaultValue(PreparedStatement stmt, int index) Set the feature's default value to the JDBCIDBPreparedStatementusing an appropriatesetXxxmethod.voidsetFeature(EStructuralFeature feature) voidsetMappingStrategy(IMappingStrategy mappingStrategy) voidsetValue(PreparedStatement stmt, int index, Object value) Set the given value to the JDBCIDBPreparedStatementusing an appropriatesetXxxmethod.voidsetValueFromRevision(PreparedStatement stmt, int index, InternalCDORevision value) Set a value of the given revision to the JDBCIDBPreparedStatementusing an appropriatesetXxxmethod.
-
Method Details
-
getFeature
EStructuralFeature getFeature()- Returns:
- The feature which is associated with this mapping.
-
getField
org.eclipse.net4j.db.ddl.IDBField getField()- Returns:
- The db field which is associated with this mapping.
-
getDBType
org.eclipse.net4j.db.DBType getDBType()- Returns:
- The db type which is associated with this mapping.
- Since:
- 3.0
-
setMappingStrategy
- Since:
- 4.0
-
setFeature
- Since:
- 4.0
-
setDBType
void setDBType(org.eclipse.net4j.db.DBType dbType) - Since:
- 4.0
-
createDBField
Deprecated.As of 4.2 usecreateDBField(IDBTable, String). -
createDBField
Creates the DBField and adds it to the given table. The name of the DBField is explicitly determined by the corresponding parameter.- Parameters:
table- the table to add this field to.fieldName- the name for the DBField.
-
setDBField
Sets the DBField. The name of the DBField is explicitly determined by the corresponding parameter.- Parameters:
table- the table to add this field to.fieldName- the name for the DBField.- Since:
- 3.0
-
setValue
Set the given value to the JDBCIDBPreparedStatementusing an appropriatesetXxxmethod.- Parameters:
stmt- the prepared statement to set the valueindex- the index to use for thesetXxxmethod.value- the value to set.- Throws:
SQLException- if thesetXxxthrows it.
-
setDefaultValue
Set the feature's default value to the JDBCIDBPreparedStatementusing an appropriatesetXxxmethod.- Parameters:
stmt- the prepared statement to set the valueindex- the index to use for thesetXxxmethod.- Throws:
SQLException- if thesetXxxthrows it.- Since:
- 3.0
-
setValueFromRevision
void setValueFromRevision(PreparedStatement stmt, int index, InternalCDORevision value) throws SQLException Set a value of the given revision to the JDBCIDBPreparedStatementusing an appropriatesetXxxmethod. The feature from which the value is taken is determined bygetFeature().- Parameters:
stmt- the prepared statement to set the valueindex- the index to use for thesetXxxmethod.value- the revision to get the value to set from.- Throws:
SQLException- if thesetXxxthrows it.
-
readValue
Read the value from aResultSetand convert it from the DB to the CDO representation. The resultSet field to read from is determined automatically by the internalgetField()name.- Parameters:
resultSet- the result set to read from- Returns:
- the read value
- Throws:
SQLException- if reading the value throws an SQLException- Since:
- 3.0
-
readValueToRevision
Read a value from aResultSet, convert it from the DB to the CDO representation and set it to the feature of the revision. The feature is determined by getFeature() The resultSet field to read from is determined automatically by the internalgetField()name.- Parameters:
resultSet- the result set to read fromrevision- the revision to which the value should be set.- Throws:
SQLException- if reading the value throws an SQLException- Since:
- 3.0
-
createDBField(IDBTable, String).