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
|
/*******************************************************************************
* Copyright (c) 2007, 2010 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.core.context.persistence;
import org.eclipse.core.resources.IFile;
import org.eclipse.jdt.core.IType;
import org.eclipse.jpt.core.JpaStructureNode;
import org.eclipse.jpt.core.context.MappingFile;
import org.eclipse.jpt.core.context.MappingFilePersistenceUnitDefaults;
import org.eclipse.jpt.core.context.PersistentType;
import org.eclipse.jpt.core.context.XmlContextNode;
import org.eclipse.jpt.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
{
// ********** 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.
*/
MappingFile getMappingFile();
// ********** updating **********
/**
* Update the mapping file ref context model to match the specified
* resource model. The refs are ordered within the <code>persistence.xml</code>
* file, so they are updated sequentially, in place, not matched up by name
* (i.e. the resource model can change).
* @see org.eclipse.jpt.core.JpaProject#update()
*/
void update(XmlMappingFileRef mappingFileRef);
// ********** queries **********
/**
* Return whether the mapping file ref is "implied" by, or explicitly
* specified in, the <code>persistence.xml</code>.
*/
boolean isImplied();
/**
* Return the mapping file's persistence unit defaults.
*/
MappingFilePersistenceUnitDefaults getPersistenceUnitDefaults();
/**
* Return whether the mapping file's persistence unit defaults exist.
*/
boolean persistenceUnitDefaultsExists();
/**
* Return the persistent type, as listed in the mapping file,
* with the specified name. Return null if it does not exists.
*/
PersistentType getPersistentType(String typeName);
/**
* 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 MappingFileRef#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);
/**
* If this {@link MappingFileRef#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> createReplaceMappingFileEdits(IFile originalFile, String newName);
}
|
