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
|
/*******************************************************************************
* Copyright (c) 2006, 2016 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;
import org.eclipse.jpt.common.utility.internal.transformer.TransformerAdapter;
import org.eclipse.jpt.common.utility.transformer.Transformer;
/**
* JPA relationship (1:1, 1:m, m:1, m:m) mapping.
* <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.2
* @since 2.0
*/
public interface RelationshipMapping
extends FetchableMapping
{
/**
* Return the meta-information used to populate the entities of the
* relationship
*/
MappingRelationship getRelationship();
Transformer<RelationshipMapping, MappingRelationship> RELATIONSHIP_TRANSFORMER = new RelationshipTransformer();
class RelationshipTransformer
extends TransformerAdapter<RelationshipMapping, MappingRelationship>
{
@Override
public MappingRelationship transform(RelationshipMapping mapping) {
return mapping.getRelationship();
}
}
/**
* Return the relationship owner or <code>null</code> if this is the owning side
* or it is a unidirectional mapping.
*/
RelationshipMapping getRelationshipOwner();
// **************** target entity **************************************
String getTargetEntity();
String getSpecifiedTargetEntity();
void setSpecifiedTargetEntity(String value);
String SPECIFIED_TARGET_ENTITY_PROPERTY = "specifiedTargetEntity"; //$NON-NLS-1$
String getDefaultTargetEntity();
String DEFAULT_TARGET_ENTITY_PROPERTY = "defaultTargetEntity"; //$NON-NLS-1$
Entity getResolvedTargetEntity();
/**
* Return all attribute names on the target entity, provided target entity
* resolves
*/
Iterable<String> getAllTargetEntityAttributeNames();
/**
* Return the names of non-transient attribute mappings on the target entity,
* provided target entity resolves
*/
Iterable<String> getTargetEntityNonTransientAttributeNames();
/**
* Return the char to be used for browsing or creating the target entity IType.
* @see org.eclipse.jdt.core.IType#getFullyQualifiedName(char)
*/
char getTargetEntityEnclosingTypeSeparator();
/**
* If the target entity is specified, this will return it fully qualified.
* If not specified, it returns the default target entity, which is always
* fully qualified
*/
String getFullyQualifiedTargetEntity();
String FULLY_QUALIFIED_TARGET_ENTITY_PROPERTY = "fullyQualifiedTargetEntity"; //$NON-NLS-1$
// **************** cascade **************************************
Cascade getCascade();
Transformer<RelationshipMapping, Cascade> CASCADE_TRANSFORMER = new CascadeTransformer();
class CascadeTransformer
extends TransformerAdapter<RelationshipMapping, Cascade>
{
@Override
public Cascade transform(RelationshipMapping mapping) {
return mapping.getCascade();
}
}
}
|
