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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/**
* Copyright (c) 2004 - 2010 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 - 271444: [DB] Multiple refactorings bug 271444
*/
package org.eclipse.emf.cdo.server.db.mapping;
import org.eclipse.emf.cdo.common.branch.CDOBranch;
import org.eclipse.emf.cdo.common.branch.CDOBranchPoint;
import org.eclipse.emf.cdo.common.id.CDOID;
import org.eclipse.emf.cdo.common.revision.CDORevision;
import org.eclipse.emf.cdo.common.revision.CDORevisionHandler;
import org.eclipse.emf.cdo.server.IStoreAccessor;
import org.eclipse.emf.cdo.server.db.IDBStoreAccessor;
import org.eclipse.emf.cdo.spi.common.commit.CDOChangeSetSegment;
import org.eclipse.emf.cdo.spi.common.revision.InternalCDORevision;
import org.eclipse.net4j.db.ddl.IDBTable;
import org.eclipse.net4j.util.ImplementationError;
import org.eclipse.net4j.util.om.monitor.OMMonitor;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EStructuralFeature;
import java.sql.PreparedStatement;
import java.util.List;
import java.util.Set;
/**
* Basic interface for class mappings.
*
* @author Eike Stepper
* @author Stefan Winkler
* @since 2.0
*/
public interface IClassMapping
{
/**
* @since 3.0
*/
public EClass getEClass();
/**
* Returns all DB tables which are used by this class and all its contained features.
*
* @return a collection of all tables of this class and all its contained features.
* @since 3.0
*/
public List<IDBTable> getDBTables();
/**
* Get the mapping of the many-valued feature.
*
* @param feature
* the feature for which the mapping should be returned. <code>feature.isMany()</code> has to be
* <code>true</code>.
* @return the list mapping corresponding to the feature.
*/
public IListMapping getListMapping(EStructuralFeature feature);
/**
* @since 3.0
*/
public List<IListMapping> getListMappings();
/**
* Read a revision. The branch and timestamp to be read are derived from the branchPoint which is set to the Revision.
* Note that non-audit stores only support {@link CDOBranchPoint#UNSPECIFIED_DATE} and non-branching stores only
* support the main branch.
*
* @param accessor
* the accessor to use.
* @param revision
* the revision object into which the data should be read. The revision has to be have its ID set to the
* requested object's ID. The version is ignored, as the version parameter is used to determine the version
* to be read.
* @param listChunk
* the chunk size to read attribute lists.
* @return <code>true</code>, if the revision has been found and read correctly. <code>false</code> if the revision
* could not be found. In this case, the content of <code>revision</code> is undefined.
*/
public boolean readRevision(IDBStoreAccessor accessor, InternalCDORevision revision, int listChunk);
/**
* Write the revision data to the database.
*
* @param accessor
* the accessor to use.
* @param revision
* the revision to write.
* @param monitor
* the monitor to indicate progress.
*/
public void writeRevision(IDBStoreAccessor accessor, InternalCDORevision revision, OMMonitor monitor);
/**
* Detaches (deletes) a CDO object leaving a "ghost" revision behind.
*
* @param accessor
* the accessor to use.
* @param id
* the id to revise
* @param version
* the last valid version plus one (needed as marker)
* @param timeStamp
* the timestamp of detach
* @param monitor
* the monitor to indicate progress.
* @since 3.0
*/
public void detachObject(IDBStoreAccessor accessor, CDOID id, int version, CDOBranch branch, long timeStamp,
OMMonitor monitor);
/**
* Create a prepared statement which returns all IDs of instances of the corresponding class.
*
* @param accessor
* the accessor to use to create the statement
* @return the prepared statement ready to be executed using <code>result.executeQuery()</code>.
* @since 3.0
*/
public PreparedStatement createObjectIDStatement(IDBStoreAccessor accessor);
/**
* Create a prepared statement which returns all IDs of instances of the corresponding class.
*
* @param accessor
* the accessor to use to create the statement
* @param folderId
* the ID of the containing folder. <code>0</code> means none.
* @param name
* the name of the resource node to look up
* @param exactMatch
* if <code>true</code>, <code>name</code> must match exactly, otherwise all resource nodes starting with
* <code>name</code> are returned.
* @param branchPoint
* a branchPoint (branch and timestamp). A timestamp in the past if past versions should be looked up. In
* case of no audit support, this must be {@link CDORevision#UNSPECIFIED_DATE}. In case of non branching
* support the branch id must be equal to {@link CDOBranch#MAIN_BRANCH_ID}.
* @return the prepared statement ready to be executed using <code>result.executeQuery()</code>.
* @throws ImplementationError
* if called on a mapping which does not map an <code>EClass instanceof CDOResourceNode</code>.
* @since 3.0
*/
public PreparedStatement createResourceQueryStatement(IDBStoreAccessor accessor, CDOID folderId, String name,
boolean exactMatch, CDOBranchPoint branchPoint);
/**
* Passes all revisions of the store to the {@link CDORevisionHandler handler} if <b>all</b> of the following
* conditions are met:
* <ul>
* <li>The <code>branch</code> parameter is <code>null</code> or equal to <code>revision.getBranch()</code>.
* <li>The <code>timeStamp</code> parameter is {@link CDOBranchPoint#UNSPECIFIED_DATE} or equal to
* <code>revision.getTimeStamp()</code>.
* </ul>
*
* @see IMappingStrategy#handleRevisions(IDBStoreAccessor, org.eclipse.emf.ecore.EClass, CDOBranch, long,
* CDORevisionHandler)
* @since 3.0
*/
public void handleRevisions(IDBStoreAccessor accessor, CDOBranch branch, long timeStamp, CDORevisionHandler handler);
/**
* Returns a set of CDOIDs that have at least one revision in any of the passed branches and time ranges.
* DetachedCDORevisions must also be considered!
*
* @see IStoreAccessor#readChangeSet(CDOChangeSetSegment...)
* @since 3.0
*/
public Set<CDOID> readChangeSet(IDBStoreAccessor accessor, CDOChangeSetSegment[] segments);
}
|
