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
|
/*******************************************************************************
* Copyright (c) 2007, 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.context.persistence;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.runtime.IPath;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.core.IType;
import org.eclipse.jpt.jpa.core.JpaStructureNode;
import org.eclipse.jpt.jpa.core.context.MappingFile;
import org.eclipse.jpt.jpa.core.context.MappingFilePersistenceUnitMetadata;
import org.eclipse.jpt.jpa.core.context.XmlContextNode;
import org.eclipse.jpt.jpa.core.resource.persistence.XmlMappingFileRef;
import org.eclipse.text.edits.DeleteEdit;
import org.eclipse.text.edits.ReplaceEdit;
/**
* Context model corresponding to the
* XML resource model {@link XmlMappingFileRef},
* which corresponds to the <code>mapping-file</code> element
* in the <code>persistence.xml</code> file.
* <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.0
* @since 2.0
*/
public interface MappingFileRef
extends XmlContextNode, JpaStructureNode, PersistentTypeContainer
{
/**
* Covariant override.
*/
PersistenceUnit getParent();
// ********** file name **********
/**
* String constant associated with changes to the file name.
*/
String FILE_NAME_PROPERTY = "fileName"; //$NON-NLS-1$
/**
* Return the file name of the mapping file ref.
*/
String getFileName();
/**
* Set the file name of the mapping file ref.
*/
void setFileName(String fileName);
/**
* Return whether the mapping file ref is a reference to the specified file.
*/
boolean isFor(IFile file);
// ********** mapping file (orm.xml) **********
/**
* String constant associated with changes to the mapping file.
*/
String MAPPING_FILE_PROPERTY = "mappingFile"; //$NON-NLS-1$
/**
* Return mapping file corresponding to the mapping file ref's file name.
* This can be <code>null</code> if the file name is invalid.
*/
MappingFile getMappingFile();
// ********** persistence unit metadata **********
/**
* Return the mapping file's persistence unit metadata.
*/
MappingFilePersistenceUnitMetadata getPersistenceUnitMetadata();
/**
* Return whether the mapping file's persistence unit metadata exist.
*/
boolean persistenceUnitMetadataExists();
// ********** misc **********
/**
* Return the mapping file ref's corresponding resource mapping file ref.
*/
XmlMappingFileRef getXmlMappingFileRef();
/**
* Return whether the mapping file ref is "implied" by, or explicitly
* specified in, the <code>persistence.xml</code>.
*/
boolean isImplied();
/**
* Return whether the specified text offset is within
* the text representation of the mapping file.
*/
boolean containsOffset(int textOffset);
// ********** refactoring **********
/**
* Create DeleteEdits for deleting any references to the given type
* that is about to be deleted.
* Return an EmptyIterable if there are not any references to the given type.
*/
Iterable<DeleteEdit> createDeleteTypeEdits(IType type);
/**
* If this {@link #isFor(IFile)} the given IFile, create a text
* DeleteEdit for deleting the mapping file element and any text that precedes it
* from the persistence.xml.
* Otherwise return an EmptyIterable.
* Though this will contain 1 or 0 DeleteEdits, using an Iterable
* for ease of use with other createDeleteEdit API.
*/
Iterable<DeleteEdit> createDeleteMappingFileEdits(IFile file);
/**
* 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);
/**
* Create ReplaceEdits for renaming any references to the originalFolder to the newName.
* The originalFolder has not yet been renamed.
*/
Iterable<ReplaceEdit> createRenameFolderEdits(IFolder originalFolder, String newName);
/**
* If this {@link #isFor(IFile)} the given IFile, create a text
* ReplaceEdit for renaming the mapping file element to the new name.
* Otherwise return an EmptyIterable.
* Though this will contain 1 or 0 ReplaceEdits, using an Iterable
* for ease of use with other createReplaceMappingFileEdits API.
*/
Iterable<ReplaceEdit> createRenameMappingFileEdits(IFile originalFile, String newName);
/**
* If this {@link #isFor(IFile)} the given IFile create a text
* ReplaceEdit for moving the originalFile to the destination.
* Otherwise return an EmptyIterable.
* The originalFile has not been moved yet.
*/
Iterable<ReplaceEdit> createMoveMappingFileEdits(IFile originalFile, IPath runtineDestination);
/**
* Create ReplaceEdits for moving any references to the originalFolder to the runtimeDestination.
* The runtimeDestination already includes the original folder name.
*/
Iterable<ReplaceEdit> createMoveFolderEdits(IFolder originalFolder, IPath runtimeDestination);
}
|
