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
|
/***************************************************************************
* Copyright (c) 2004 - 2008 Eike Stepper, Germany.
* 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
* Simon McDuff - http://bugs.eclipse.org/230832
**************************************************************************/
package org.eclipse.emf.cdo.server;
import org.eclipse.emf.cdo.common.CDOProtocolView;
import org.eclipse.emf.cdo.common.id.CDOID;
import org.eclipse.emf.cdo.common.model.CDOClassRef;
import org.eclipse.emf.cdo.common.model.CDOFeature;
import org.eclipse.emf.cdo.common.model.CDOPackage;
import org.eclipse.emf.cdo.common.model.CDOPackageInfo;
import org.eclipse.emf.cdo.common.query.CDOQueryInfo;
import org.eclipse.emf.cdo.common.revision.CDORevision;
import org.eclipse.net4j.util.collection.CloseableIterator;
import java.util.Collection;
/**
* @see StoreThreadLocal#getStoreReader()
* @author Eike Stepper
*/
public interface IStoreReader extends IStoreAccessor, IQueryHandler
{
public ISession getSession();
public IStoreChunkReader createChunkReader(CDORevision revision, CDOFeature feature);
public Collection<CDOPackageInfo> readPackageInfos();
/**
* Demand loads a given package proxy that has been created on startup of the repository.
*/
public void readPackage(CDOPackage cdoPackage);
/**
* Returns an iterator that iterates over all objects in the store and makes their CDOIDs available for processing.
* This method is supposed to be called very infrequently, for example during the recovery from a crash.
*
* @since 2.0
*/
public CloseableIterator<CDOID> readObjectIDs();
/**
* Reads the type of an object from the associated store and returns a class reference of it. This method is supposed
* to be called very infrequently if the {@link IStore#hasEfficientTypeLookup()} returns <code>false</code>.
*/
public CDOClassRef readObjectType(CDOID id);
/**
* Reads a current revision (i.e. one with revised == 0) from the backend. Returns <code>null</code> if the id is
* invalid.
*/
public CDORevision readRevision(CDOID id, int referenceChunk);
/**
* Reads a revision with the given version from the backend. This method will only be called by the framework if
* {@link IRepository#isSupportingAudits()} is <code>true</code> (which in turn requires
* {@link IStore#hasAuditingSupport()} to be <code>true</code>). Returns <code>null</code> if the id is invalid.
*/
public CDORevision readRevisionByVersion(CDOID id, int referenceChunk, int version);
/**
* Reads a revision from the backend that was valid at the given timeStamp. This method will only be called by the
* framework if {@link IRepository#isSupportingAudits()} is <code>true</code> (which in turn requires
* {@link IStore#hasAuditingSupport()} to be <code>true</code>). Returns <code>null</code> if the id is invalid.
*/
public CDORevision readRevisionByTime(CDOID id, int referenceChunk, long timeStamp);
/**
* Returns the <code>CDOID</code> of the resource node with the given folderID and name if a resource with this
* folderID and name exists in the store, <code>null</code> otherwise.
*
* @since 2.0
*/
public CDOID readResourceID(CDOID folderID, String name, long timeStamp);
public CDORevision verifyRevision(CDORevision revision);
/**
* TODO Clarify the meaning of {@link IStoreReader#refreshRevisions()}
*
* @since 2.0
*/
public void refreshRevisions();
/**
* @since 2.0
*/
public void queryResources(QueryResourcesContext context);
/**
* @author Eike Stepper
* @since 2.0
*/
public interface QueryResourcesContext
{
/**
* The timeStamp of the view ({@link CDOProtocolView#UNSPECIFIED_DATE} if the view is an
* {@link CDOProtocolView.Type#AUDIT audit} view.
*/
public long getTimeStamp();
public String getNamePrefix();
/**
* Returns the maximum number of results expected by the client or {@link CDOQueryInfo#UNLIMITED_RESULTS} for no
* limitation.
*/
public int getMaxResults();
/**
* Adds the CDOID of one resource to the results of the underlying query.
*
* @return <code>true</code> to indicate that more results can be passed subsequently, <code>false</code> otherwise
* (i.e. maxResults has been reached or an asynchronous query has been canceled).
*/
public boolean addResource(CDOID resourceID);
}
}
|
