blob: 1930e2db23017b91d333ebbba2274cd3fdb843d8 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/**
* Copyright (c) 2004 - 2009 Eike Stepper (Berlin, Germany) and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eike Stepper - initial API and implementation
* Stefan Winkler - major refactoring
*/
package org.eclipse.emf.cdo.server.db.mapping;
import org.eclipse.emf.cdo.spi.common.revision.InternalCDORevision;
import org.eclipse.net4j.db.ddl.IDBField;
import org.eclipse.net4j.db.ddl.IDBTable;
import org.eclipse.emf.ecore.EStructuralFeature;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
/**
* Mapping of single values to and from the database.
*
* @author Eike Stepper
* @author Stefan Winkler
* @since 2.0
*/
public interface ITypeMapping
{
/**
* @return The feature which is associated with this mapping.
*/
public EStructuralFeature getFeature();
/**
* @return The db field which is associated with this mapping.
*/
public IDBField getField();
/**
* Creates the DBField and adds it to the given table. The name of the DBField is derived from the feature.
*
* @param table
* the table to add this field to.
*/
public void createDBField(IDBTable table);
/**
* Creates the DBField and adds it to the given table. The name of the DBField is explicitly determined by the
* corresponding parameter.
*
* @param table
* the table to add this field to.
* @param fieldName
* the name for the DBField.
*/
public void createDBField(IDBTable table, String fieldName);
/**
* Set the given value to the JDBC {@link PreparedStatement} using an appropriate <code>setXxx</code> method.
*
* @param stmt
* the prepared statement to set the value
* @param index
* the index to use for the <code>setXxx</code> method.
* @param value
* the value to set.
* @throws SQLException
* if the <code>setXxx</code> throws it.
*/
public void setValue(PreparedStatement stmt, int index, Object value) throws SQLException;
/**
* Set a value of the given revision to the JDBC {@link PreparedStatement} using an appropriate <code>setXxx</code>
* method. The feature from which the value is taken is determined by {@link #getFeature()}.
*
* @param stmt
* the prepared statement to set the value
* @param index
* the index to use for the <code>setXxx</code> method.
* @param revision
* the revision to get the value to set from.
* @throws SQLException
* if the <code>setXxx</code> throws it.
*/
public void setValueFromRevision(PreparedStatement stmt, int index, InternalCDORevision value) throws SQLException;
/**
* Read a value from a {@link ResultSet} and convert it from the DB to the CDO representation.
*
* @param resultSet
* the result set to read from
* @param i
* the column index in the result set to read from
* @return the read value
* @throws SQLException
* if reading the value throws an SQLException
*/
public Object readValue(ResultSet resultSet, int i) throws SQLException;
/**
* Read a value from a {@link ResultSet}, convert it from the DB to the CDO representation and set it to the feature
* of the revision. The feature is determined by getFeature()
*
* @param resultSet
* the result set to read from
* @param i
* the column index in the result set to read from
* @param revision
* the revision to which the value should be set.
* @throws SQLException
* if reading the value throws an SQLException
*/
public void readValueToRevision(ResultSet resultSet, int i, InternalCDORevision revision) throws SQLException;
}
|
