blob: 7f6e2bb07100ee002d56d080755ba6feb87b9865 (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2008, 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.context.orm;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.core.IType;
import org.eclipse.jpt.common.core.utility.TextRange;
import org.eclipse.jpt.jpa.core.context.TypeMapping;
import org.eclipse.jpt.jpa.core.context.XmlContextNode;
import org.eclipse.jpt.jpa.core.context.java.JavaTypeMapping;
import org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings;
import org.eclipse.jpt.jpa.core.resource.orm.XmlTypeMapping;
import org.eclipse.text.edits.DeleteEdit;
import org.eclipse.text.edits.ReplaceEdit;
/**
* <code>orm.xml</code> type mapping
* <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 3.2
* @since 2.0
*/
public interface OrmTypeMapping
extends TypeMapping, XmlContextNode
{
// ********** class **********
/**
* <strong>NB:</strong> This may be an unqualified name to be prefixed by the
* entity mappings's package value.
*
* @see EntityMappings#getPackage()
*/
String getClass_();
/**
* @see #getClass_()
*/
void setClass(String class_);
String CLASS_PROPERTY = "class"; //$NON-NLS-1$
// ********** metadata complete **********
boolean isMetadataComplete();
Boolean getSpecifiedMetadataComplete();
void setSpecifiedMetadataComplete(Boolean metadataComplete);
String SPECIFIED_METADATA_COMPLETE_PROPERTY = "specifiedMetadataComplete"; //$NON-NLS-1$
/**
* Override metadata complete is true if the type mapping's persistence
* unit is marked "XML mapping metadata complete".
*/
boolean isOverrideMetadataComplete();
String OVERRIDE_METADATA_COMPLETE_PROPERTY = "overrideMetadataComplete"; //$NON-NLS-1$
// ********** XML **********
/**
* Type mappings are a sequence in the orm schema. We must keep
* the list of type mappings in the appropriate order so the wtp xml
* translators will write them to the xml in that order and they
* will adhere to the schema.
* <p>
* Each concrete implementation must implement this
* method and return an int that matches its order in the schema.
*/
int getXmlSequence();
/**
* Add the type mapping's XML type mapping to the appropriate list
* in the specified XML entity mappings.
*/
void addXmlTypeMappingTo(XmlEntityMappings entityMappings);
/**
* Remove the type mapping's XML type mapping from the appropriate list
* in the specified XML entity mappings.
*/
void removeXmlTypeMappingFrom(XmlEntityMappings entityMappings);
XmlTypeMapping getXmlTypeMapping();
TextRange getSelectionTextRange();
TextRange getClassTextRange();
TextRange getAttributesTextRange();
boolean containsOffset(int textOffset);
// ********** Java type mapping **********
/**
* Return the Java type mapping corresponding to the <code>orm.xml</code>
* type mapping. Return <code>null</code> if there is no such Java type
* mapping; i.e. it does not exist or it is not the same type of type
* mapping (entity, mapped superclass, embeddable).
*
* @see #getJavaTypeMappingForDefaults()
*/
JavaTypeMapping getJavaTypeMapping();
/**
* Check "metadata complete" before returning the Java type mapping.
* For <code>orm.xml</code> defaults, if "metadata complete" is
* <code>true</code>, return <code>null</code>.
*
* @see #getJavaTypeMapping()
*/
JavaTypeMapping getJavaTypeMappingForDefaults();
// ********** refactoring **********
/**
* Create a text DeleteEdit for deleting the type mapping element and any text that precedes it
*/
DeleteEdit createDeleteEdit();
/**
* Create ReplaceEdits for renaming any references to the originalType to the newName.
* The originalType has not yet been renamed, the newName is the new short name.
*/
Iterable<ReplaceEdit> createRenameTypeEdits(IType originalType, String newName);
/**
* Create ReplaceEdits for moving any references to the originalType to the newPackage.
* The originalType has not yet been moved.
*/
Iterable<ReplaceEdit> createMoveTypeEdits(IType originalType, IPackageFragment newPackage);
/**
* Create ReplaceEdits for renaming any references to the originalPackage to the newName.
* The originalPackage has not yet been renamed.
*/
Iterable<ReplaceEdit> createRenamePackageEdits(IPackageFragment originalPackage, String newName);
// ********** misc **********
OrmPersistentType getPersistentType();
void initializeFrom(OrmTypeMapping oldMapping);
}
|
