blob: a9dfcb63b764aac7b1364a7286f150a0a3503fd1 (
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
|
/*******************************************************************************
* Copyright (c) 2009, 2011 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;
/**
* A relationship contains the settings describing how entities are related
* in a {@link RelationshipMapping} or {@link AssociationOverride}:<ul>
* <li>join column
* <li>join table
* <li>"mapped by"
* <li>primary key join column
* </ul>
* Supported mappings:<ul>
* <li>1:1
* <li>1:m
* <li>m:1
* <li>m:m
* </ul>
* 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.
*
* @see RelationshipMapping
* @see AssociationOverride
*/
public interface ReadOnlyRelationship
extends JpaContextNode
{
/**
* Return the relationship's mapping; which for a mapping relationship is
* the relationship's parent, but in the case of an override is the
* overridden mapping (from a superclass or embeddable type).
*/
RelationshipMapping getMapping();
/**
* Return the type mapping that contains the relationship's mapping or
* override.
*/
TypeMapping getTypeMapping();
/**
* Return the entity that contains the relationship's mapping or override.
* This is just a convenience method that calls {@link #getTypeMapping()}
* and returns <code>null</code> if the result is not an {@link Entity}.
*/
Entity getEntity();
/**
* String associated with changes to the predominant strategy property
*/
final static String PREDOMINANT_JOINING_STRATEGY_PROPERTY = "predominantStrategy"; //$NON-NLS-1$
/**
* Return the current strategy, this is never <code>null</code>.
*/
ReadOnlyRelationshipStrategy getPredominantJoiningStrategy();
/**
* Return whether the the relationship is virtual.
*/
boolean isVirtual();
void initializeOn(Relationship newRelationship);
}
|
