blob: 556f402161a5a2208ea3162196ec13995dbd6f7a (
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
|
/*******************************************************************************
* 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.resource.java;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jpt.core.utility.TextRange;
/**
* Common protocol among
* javax.persistence.ManyToOne
* javax.persistence.ManyToMany
* javax.persistence.OneToMany
* javax.persistence.OneToOne
*
* 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.2
* @since 2.0
*/
public interface RelationshipMappingAnnotation
extends Annotation
{
/**
* Corresponds to the 'targetEntity' element of the relationship mapping
* annotations.
* Return null if the element does not exist in Java.
* Return the portion of the value preceding ".class".
* <pre>
* @ManyToMany(targetEntity=Employee.class)
* </pre>
* will return "Employee"
*/
String getTargetEntity();
String TARGET_ENTITY_PROPERTY = "targetEntity"; //$NON-NLS-1$
/**
* Corresponds to the 'targetEntity' element of the relationship mapping
* annotations.
* Set to null to remove the element.
*/
void setTargetEntity(String targetEntity);
/**
* Return the {@link TextRange} for the 'targetEntity' element. If the element
* does not exist return the {@link TextRange} for the relationship mapping annotation.
*/
TextRange getTargetEntityTextRange(CompilationUnit astRoot);
/**
* Return the fully-qualified target entity class name as resolved by the AST's bindings.
* <pre>
* @ManyToMany(targetEntity=Employee.class)
* </pre>
* will return "model.Employee" if there is an import for model.Employee.
* @return
*/
String getFullyQualifiedTargetEntityClassName();
String FULLY_QUALIFIED_TARGET_ENTITY_CLASS_NAME_PROPERTY = "fullyQualifiedTargetEntityClassName"; //$NON-NLS-1$
/**
* Corresponds to the 'fetch' element of the relationship mapping annotations.
* Return null if the element does not exist in Java.
*/
FetchType getFetch();
String FETCH_PROPERTY = "fetch"; //$NON-NLS-1$
/**
* Corresponds to the 'fetch' element of the relationship annotations.
* Set to null to remove the element.
*/
void setFetch(FetchType fetch);
/**
* Return the {@link TextRange} for the 'fetch' element. If the element
* does not exist return the {@link TextRange} for the relationship mapping annotation.
*/
TextRange getFetchTextRange(CompilationUnit astRoot);
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
boolean isCascadeAll();
String CASCADE_ALL_PROPERTY = "cascadeAll"; //$NON-NLS-1$
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
void setCascadeAll(boolean all);
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
boolean isCascadeMerge();
String CASCADE_MERGE_PROPERTY = "cascadeMerge"; //$NON-NLS-1$
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
void setCascadeMerge(boolean merge);
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
boolean isCascadePersist();
String CASCADE_PERSIST_PROPERTY = "cascadePersist"; //$NON-NLS-1$
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
void setCascadePersist(boolean persist);
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
boolean isCascadeRefresh();
String CASCADE_REFRESH_PROPERTY = "cascadeRefresh"; //$NON-NLS-1$
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
void setCascadeRefresh(boolean refresh);
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
boolean isCascadeRemove();
String CASCADE_REMOVE_PROPERTY = "cascadeRemove"; //$NON-NLS-1$
/**
* Corresponds to the 'cascade' element of the relationship annotations.
*/
void setCascadeRemove(boolean remove);
/**
* Return the {@link TextRange} for the 'cascade' element. If the element
* does not exist return the {@link TextRange} for the relationship mapping annotation.
*/
TextRange getCascadeTextRange(CompilationUnit astRoot);
}
|
