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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
/*******************************************************************************
* Copyright (c) 2011, 2012 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* Oracle - initial API and implementation
*
******************************************************************************/
package org.eclipse.jpt.jpa.ui.internal.jpql;
import java.util.Collections;
import java.util.List;
import org.eclipse.core.filebuffers.FileBuffers;
import org.eclipse.core.filebuffers.ITextFileBuffer;
import org.eclipse.core.filebuffers.ITextFileBufferManager;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IWorkspaceRoot;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.contentassist.ICompletionProposal;
import org.eclipse.jface.text.contentassist.IContextInformation;
import org.eclipse.jpt.common.core.utility.TextRange;
import org.eclipse.jpt.common.utility.internal.StringTools;
import org.eclipse.jpt.jpa.core.JpaFile;
import org.eclipse.jpt.jpa.core.JpaStructureNode;
import org.eclipse.jpt.jpa.core.context.PersistentType;
import org.eclipse.jpt.jpa.core.context.TypeMapping;
import org.eclipse.jpt.jpa.core.context.orm.EntityMappings;
import org.eclipse.jpt.jpa.core.context.orm.OrmEntity;
import org.eclipse.jpt.jpa.core.context.orm.OrmNamedQuery;
import org.eclipse.jpt.jpa.core.context.orm.OrmQueryContainer;
import org.eclipse.jpt.jpa.core.jpql.XmlEscapeCharacterConverter;
import org.eclipse.jpt.jpa.ui.internal.JptUiMessages;
import org.eclipse.jpt.jpa.ui.internal.plugin.JptJpaUiPlugin;
import org.eclipse.swt.graphics.Image;
import org.eclipse.wst.sse.ui.contentassist.CompletionProposalInvocationContext;
import org.eclipse.wst.sse.ui.contentassist.ICompletionProposalComputer;
/**
* This computer adds content assist support when it is invoked inside the <query> element
* defined in a mapping file (ORM Configuration).
*
* @version 3.3
* @since 3.0
* @author Pascal Filion
*/
public final class JpaJpqlSseCompletionProposalComputer extends JpqlCompletionProposalComputer<ICompletionProposal>
implements ICompletionProposalComputer {
private boolean cDATASection;
/**
* Creates a new <code>JpaJpqlSseCompletionProposalComputer</code>.
*/
public JpaJpqlSseCompletionProposalComputer() {
super();
}
/**
* {@inheritDoc}
*/
@Override
ICompletionProposal buildProposal(String proposal,
String displayString,
String additionalInfo,
Image image,
int cursorOffset) {
return new JpqlSseCompletionProposal(
contentAssistProposals,
proposal,
displayString,
additionalInfo,
image,
namedQuery,
jpqlQuery,
actualQuery,
tokenStart,
tokenEnd,
position,
actualPosition,
cursorOffset,
cDATASection
);
}
/**
* {@inheritDoc}
*/
public List<ICompletionProposal> computeCompletionProposals(CompletionProposalInvocationContext context,
IProgressMonitor monitor) {
monitor.beginTask(null, 100);
try {
int offset = context.getInvocationOffset();
if (offset == -1) return Collections.emptyList();
ITextFileBufferManager manager = FileBuffers.getTextFileBufferManager();
ITextFileBuffer buffer = manager.getTextFileBuffer(context.getDocument());
if (buffer == null) return Collections.emptyList();
IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot();
IFile file = root.getFile(buffer.getLocation());
JpaFile jpaFile = (JpaFile) file.getAdapter(JpaFile.class);
if (jpaFile == null) return Collections.emptyList();
monitor.worked(80);
checkCanceled(monitor);
// Retrieve the JPA's model object
int[] position = new int[1];
OrmNamedQuery namedQuery = namedQuery(jpaFile, offset, position);
if (namedQuery == null) return Collections.emptyList();
// Retrieve the entire JPQL query from the document
Object[] info = jpqlQuery(namedQuery, context.getDocument());
String jpqlQuery = (String) info[0];
this.cDATASection = (Boolean) info[1];
// Keep track of the beginning and ending offsets since the entire string is always replaced
int tokenStart = offset - position[0];
int tokenEnd = tokenStart + jpqlQuery.length();
// Now create the proposals
return buildProposals(namedQuery, jpqlQuery, tokenStart, tokenEnd, position[0]);
}
catch (Exception ex) {
JptJpaUiPlugin.instance().logError(ex, JptUiMessages.JpaJpqlSseCompletionProposalComputer_Error);
}
finally {
monitor.done();
}
return Collections.emptyList();
}
/**
* {@inheritDoc}
*/
public List<IContextInformation> computeContextInformation(CompletionProposalInvocationContext context,
IProgressMonitor monitor) {
return Collections.emptyList();
}
private OrmNamedQuery findNamedQuery(JpaStructureNode structureNode, int offset, int[] position) {
if (structureNode instanceof EntityMappings) {
EntityMappings entityMappings = (EntityMappings) structureNode;
// First look into the global queries
OrmNamedQuery query = findNamedQuery(entityMappings.getQueryContainer(), offset, position);
// Now traverse each entity
if (query != null) {
return query;
}
for (PersistentType persistentType : entityMappings.getPersistentTypes()) {
TypeMapping typeMapping = persistentType.getMapping();
if (typeMapping instanceof OrmEntity) {
query = findNamedQuery(((OrmEntity) typeMapping).getQueryContainer(), offset, position);
if (query != null) {
return query;
}
}
}
}
return null;
}
private OrmNamedQuery findNamedQuery(OrmQueryContainer container, int offset, int[] position) {
for (OrmNamedQuery namedQuery : container.getNamedQueries()) {
for (TextRange textRange : namedQuery.getQueryTextRanges()) {
if (textRange.touches(offset)) {
position[0] = offset - textRange.getOffset();
return namedQuery;
}
}
}
return null;
}
private Object[] jpqlQuery(OrmNamedQuery namedQuery, IDocument document) {
try {
TextRange range = namedQuery.getQueryTextRanges().get(0);
return new Object[] {
document.get(range.getOffset(), range.getLength()),
namedQuery.getXmlQuery().isQueryInsideCDATASection()
};
}
catch (BadLocationException e) {
return new Object[] {
StringTools.EMPTY_STRING,
Boolean.FALSE
};
}
}
/**
* {@inheritDoc}
*/
@Override
String modifyJpqlQuery(String jpqlQuery, int[] position) {
// The JPQL query is not encapsulated by a CDATA section,
// converts any escape characters like < into '<'
if (!cDATASection) {
// TODO: UPDATE TO USE ECLIPSELINK HERMES 2.5 M2 ONCE IT IS AVAILABLE
jpqlQuery = XmlEscapeCharacterConverter.unescape(jpqlQuery, position);
}
return jpqlQuery;
}
private OrmNamedQuery namedQuery(JpaFile jpaFile, int offset, int[] position) {
for (JpaStructureNode node : jpaFile.getRootStructureNodes()) {
OrmNamedQuery namedQuery = findNamedQuery(node, offset, position);
if (namedQuery != null) {
return namedQuery;
}
}
return null;
}
}
|
