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
|
/*******************************************************************************
* Copyright (c) 2007, 2008 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;
/**
*
*
* 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.
*/
public interface RelationshipMappingAnnotation extends JavaResourceNode
{
/**
* Corresponds to the targetEntity element of the relationship
* annotations (ManyToMany, OneToMany, ManyToOne, OneToOne).
* Returns null if the targetEntity element does not exist in java.
* Returns the portion of the targetEntity preceding the .class.
* <p>
* @ManyToMany(targetEntity=Employee.class)
* </p>
* will return "Employee"
**/
String getTargetEntity();
/**
* Corresponds to the targetEntity of the relationship
* annotations (ManyToMany, OneToMany, ManyToOne, OneToOne).
* Set to null to remove the targetEntity element.
*/
void setTargetEntity(String targetEntity);
String TARGET_ENTITY_PROPERTY = "targetEntityProperty";
/**
* Returns the qualified targetEntity name as it is resolved in the AST
* <p>
* @ManyToMany(targetEntity=Employee.class)
* </p>
* will return "model.Employee" if there is an import for model.Employee
* @return
*/
String getFullyQualifiedTargetEntity();
String FULLY_QUALFIEID_TARGET_ENTITY_PROPERTY = "fullyQualifiedTargetEntityProperty";
/**
* Corresponds to the fetch element of the relationship
* annotations (ManyToMany, OneToMany, ManyToOne, OneToOne).
* Returns null if the fetch element does not exist in java.
*/
FetchType getFetch();
/**
* Corresponds to the fetch element of the relationship
* annotations (ManyToMany, OneToMany, ManyToOne, OneToOne).
* Set to null to remove the fetch element.
*/
void setFetch(FetchType fetch);
String FETCH_PROPERTY = "fetchProperty";
boolean isCascadeAll();
void setCascadeAll(boolean all);
String CASCADE_ALL_PROPERTY = "cascadeAllProperty";
boolean isCascadeMerge();
void setCascadeMerge(boolean merge);
String CASCADE_MERGE_PROPERTY = "cascadeMergeProperty";
boolean isCascadePersist();
void setCascadePersist(boolean persist);
String CASCADE_PERSIST_PROPERTY = "cascadePersistProperty";
boolean isCascadeRefresh();
void setCascadeRefresh(boolean refresh);
String CASCADE_REFRESH_PROPERTY = "cascadeRefreshProperty";
boolean isCascadeRemove();
void setCascadeRemove(boolean remove);
String CASCADE_REMOVE_PROPERTY = "cascadeRemoveProperty";
/**
* Return the {@link TextRange} for the targetEntity element. If the targetEntity element
* does not exist return the {@link TextRange} for the mapping annotation.
*/
TextRange getTargetEntityTextRange(CompilationUnit astRoot);
/**
* Return the {@link TextRange} for the fetch element. If the fetch element
* does not exist return the {@link TextRange} for the mapping annotation.
*/
TextRange getFetchTextRange(CompilationUnit astRoot);
/**
* Return the {@link TextRange} for the cascade element. If the cascade element
* does not exist return the {@link TextRange} for the mapping annotation.
*/
TextRange getCascadeTextRange(CompilationUnit astRoot);
}
|
