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
|
/*******************************************************************************
* Copyright (c) 2006, 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.orm;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.core.IType;
import org.eclipse.jpt.core.context.PersistentAttribute;
import org.eclipse.jpt.core.context.XmlContextNode;
import org.eclipse.jpt.core.context.java.JavaPersistentAttribute;
import org.eclipse.text.edits.ReplaceEdit;
/**
* ORM persistent attribute
*
* 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 OrmPersistentAttribute
extends PersistentAttribute, XmlContextNode
{
// ********** covariant overrides **********
OrmAttributeMapping getMapping();
OrmAttributeMapping getSpecifiedMapping();
OrmTypeMapping getOwningTypeMapping();
OrmPersistentType getOwningPersistentType();
// ********** java persistent attribute **********
JavaPersistentAttribute getJavaPersistentAttribute();
String JAVA_PERSISTENT_ATTRIBUTE_PROPERTY = "javaPersistentAttribute"; //$NON-NLS-1$
// ********** virtual <-> specified **********
/**
* Make the persistent attribute virtual. The attribute will be removed
* from the list of specified persistent attributes on the {@link OrmPersistentType}
* and removed from the orm.xml file.
*
* If the persistent attribute is already virtual, an IllegalStateException is thrown
* @see PersistentAttribute#isVirtual()
*/
void makeVirtual();
/**
* Take a virtual persistent attribute and specify it.
* The attribute will be added to the list of specified persistent attributes
* and added to the orm.xml file. The mappingKey will remain the same.
*
* If the persistent attribute is already specified, an IllegalStateException is thrown
* @see PersistentAttribute#isVirtual()
*/
void makeSpecified();
/**
* Take a virtual persistent attribute and specify it.
* The attribute will be added to the list of specified persistent attributes
* and added to the orm.xml file. The mappingKey will determine the type of mapping added
* instead of the mappingKey already on the persistent attribute
*
* If the persistent attribute is already specified, an IllegalStateException is thrown
* @see PersistentAttribute#isVirtual()
*/
void makeSpecified(String mappingKey);
// ********** updating **********
/**
* Update the OrmPersistentAttribute context model object to match the
* resource model object. see {@link org.eclipse.jpt.core.JpaProject#update()}
*/
void update();
// ********** refactoring **********
/**
* 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);
// ********** miscellaneous **********
boolean contains(int textOffset);
void nameChanged(String oldName, String newName);
/**
* interface allowing persistent attributes to be used in multiple places
* (e.g. virtual and specified orm persistent attributes)
*/
interface Owner
{
/**
* Return the java persistent attribute that corresponds (same name and access type)
* to the given ormPersistentAttribute or null if none exists.
*/
JavaPersistentAttribute findJavaPersistentAttribute(OrmPersistentAttribute ormPersistentAttribute);
/**
* Update the java persistent attribute if necessary, if it is owned by this object,
* it needs to be updated.
*/
void updateJavaPersistentAttribute();
}
}
|
