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
|
/*******************************************************************************
* Copyright (c) 2010, 2011 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.context;
import java.util.Collection;
import java.util.Comparator;
import java.util.Map;
import org.eclipse.core.resources.IFile;
import org.eclipse.jpt.common.core.utility.BodySourceWriter;
import org.eclipse.jpt.common.utility.internal.iterables.ListIterable;
import org.eclipse.jpt.jpa.core.JpaProject;
import org.eclipse.jpt.jpa.core.context.PersistentType;
import org.eclipse.jpt.jpa.core.context.ReadOnlyPersistentAttribute;
import com.ibm.icu.text.Collator;
/**
* JPA 2.0 metamodel source type.
* <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 MetamodelSourceType {
/**
* Return the source type's name.
*/
String getName();
/**
* Return whether the source type is "managed" (i.e. persistent).
*/
boolean isManaged();
/**
* Return the source type's super type.
*/
PersistentType getSuperPersistentType();
/**
* Return the source type's attributes.
*/
ListIterable<? extends ReadOnlyPersistentAttribute> getAttributes();
/**
* Return the file generated as a result of the metamodel synchronization.
*/
IFile getMetamodelFile();
/**
* Return the source type's JPA project.
*/
JpaProject getJpaProject();
/**
* Synchronize the source type's metamodel, using the specified member type
* tree.
*/
void synchronizeMetamodel(Map<String, Collection<MetamodelSourceType>> memberTypeTree);
/**
* Print the body of the source type's metamodel class on the specified
* writer, using the specified member type tree.
*/
void printBodySourceOn(BodySourceWriter pw, Map<String, Collection<MetamodelSourceType>> memberTypeTree);
/**
* {@link Comparator} that can be used to compare source types.
*/
Comparator<MetamodelSourceType> COMPARATOR =
new Comparator<MetamodelSourceType>() {
public int compare(MetamodelSourceType type1, MetamodelSourceType type2) {
return Collator.getInstance().compare(type1.getName(), type2.getName());
}
};
/**
* This interface is used by the source type to synchronize the metamodel
* as required by changes to the context model.
*/
interface Synchronizer {
/**
* Return the file generated as a result of the metamodel synchronization.
*/
IFile getFile();
/**
* Synchronize the metamodel with the current state of the source
* type, using the specified member type tree.
*/
void synchronize(Map<String, Collection<MetamodelSourceType>> memberTypeTree);
/**
* Print the body of the metamodel class on the specified writer,
* using the specified member type tree.
*/
void printBodySourceOn(BodySourceWriter pw, Map<String, Collection<MetamodelSourceType>> memberTypeTree);
}
}
|
