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
|
/*******************************************************************************
* Copyright (c) 2009, 2012 Oracle. 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:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.jpa.core.jpa2;
import java.io.Serializable;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jdt.core.IPackageFragmentRoot;
import org.eclipse.jpt.common.core.resource.java.JavaResourceAbstractType;
import org.eclipse.jpt.common.utility.internal.StringTools;
import org.eclipse.jpt.jpa.core.jpa2.resource.java.GeneratedAnnotation;
import org.eclipse.jpt.jpa.core.jpa2.resource.java.StaticMetamodelAnnotation;
/**
* JPA 2.0 Canonical Metamodel synchronizer.
* <p>
* Notes:
* <ul><li>
* When a JPA project is first created (e.g. when the user adds the JPA
* Facet to a Faceted project or when a workspace containing a JPA project is
* opened), if it is configured to generate the
* Canonical Metamodel (i.e. its metamodel source folder is non-
* <code>null</code>), it will
* first discover what metamodel classes are already present in the metamodel
* source folder. Any class appropriately annotated with
* <code>javax.persistence.metamodel.StaticMetamodel</code>
* and <code>javax.annotation.Generated</code>
* will be added to the Canonical Metamodel
* (see {@link MetamodelTools#isGeneratedMetamodelTopLevelType(JavaResourceAbstractType, IPackageFragmentRoot)}).
* Once the JPA project's context model is constructed, a new Canonical
* Metamodel is generated and merged with the classes already present in the
* metamodel source folder.
* </li><li>
* When a JPA project's metamodel source folder setting is cleared, the Canonical
* Metamodel is cleared from the context model, but the generated source files are
* left in place.
* </li><li>
* When a JPA project's metamodel source folder is set to a non-<code>null</code> value,
* like when a JPA project is first created, the resulting Canonical Metamodel
* will be merged with whatever is already present in the folder.
* </li></ul>
* <p>
* Provisional API: This interface is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*
* @version 2.3
* @since 2.3
*/
public interface MetamodelSynchronizer {
/**
* The value used to tag a generated type:
* <pre>
* @javax.annotation.Generated(value="Dali", date="2009-11-23T13:56:06.171-0500")
* </pre>
*/
String METAMODEL_GENERATED_ANNOTATION_VALUE = "Dali"; //$NON-NLS-1$
void initializeMetamodel();
IStatus synchronizeMetamodel(IProgressMonitor progressMonitor);
void disposeMetamodel();
/**
* Singleton implementation of the metamodel synchronizer interface that
* does nothing. (Not sure we need this....)
*/
final class Null
implements MetamodelSynchronizer, Serializable
{
public static final MetamodelSynchronizer INSTANCE = new Null();
public static MetamodelSynchronizer instance() {
return INSTANCE;
}
// ensure single instance
private Null() {
super();
}
public void initializeMetamodel() {
// do nothing
}
public IStatus synchronizeMetamodel(IProgressMonitor monitor) {
return Status.OK_STATUS;
}
public void disposeMetamodel() {
// do nothing
}
@Override
public String toString() {
return StringTools.buildSingletonToString(this);
}
private static final long serialVersionUID = 1L;
private Object readResolve() {
// replace this object with the singleton
return INSTANCE;
}
}
final class MetamodelTools {
/**
* The type must be:<ul>
* <li>in the specified source folder
* <li>a top-level type
* <li>annotated with <code>@javax.annotation.Generated</code> with
* the appropriate <code>value</code> and <code>date</code>
* <li>either itself or one of its nested types annotated with
* <code>@javax.persistence.metamodel.StaticMetamodel</code>
* </ul>
*/
public static boolean isGeneratedMetamodelTopLevelType(JavaResourceAbstractType jrat, IPackageFragmentRoot sourceFolder) {
if ( ! jrat.isIn(sourceFolder)) {
return false;
}
return isGeneratedMetamodelTopLevelType(jrat);
}
/**
* The type must be:<ul>
* <li>a top-level type
* <li>annotated with <code>@javax.annotation.Generated</code> with
* the appropriate <code>value</code> and <code>date</code>
* <li>either itself or one of its nested types annotated with
* <code>@javax.persistence.metamodel.StaticMetamodel</code>
* </ul>
*/
public static boolean isGeneratedMetamodelTopLevelType(JavaResourceAbstractType jrat) {
if ( ! isGenerated(jrat)) {
return false;
}
// if we get here we know we have a top-level type, since only top-level
// types are annotated @Generated; now see if anything is a metamodel
return isMetamodel(jrat);
}
/**
* The type must be annotated with
* <code>@javax.annotation.Generated</code> with the appropriate
* <code>value</code> and <code>date</code>.
*/
public static boolean isGenerated(JavaResourceAbstractType jrat) {
GeneratedAnnotation generatedAnnotation = (GeneratedAnnotation) jrat.getAnnotation(GeneratedAnnotation.ANNOTATION_NAME);
if (generatedAnnotation == null) {
return false;
}
if (generatedAnnotation.getValuesSize() != 1) {
return false;
}
if ( ! generatedAnnotation.getValue(0).equals(METAMODEL_GENERATED_ANNOTATION_VALUE)) {
return false;
}
if (StringTools.stringIsEmpty(generatedAnnotation.getDate())) {
return false;
}
return true;
}
public static boolean isMetamodel(JavaResourceAbstractType jrat) {
// if we get here we know we have a top-level type, since only top-level
// types are annotated @Generated; now see if anything is a metamodel
for (JavaResourceAbstractType type : jrat.getAllTypes()) {
if (type.getAnnotation(StaticMetamodelAnnotation.ANNOTATION_NAME) != null) {
return true;
}
}
return false;
}
}
}
|
