blob: 2e81b5340e2600b17b47b88bef2638ed1431095f (
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
|
/*******************************************************************************
* Copyright (c) 2009, 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;
import java.util.ListIterator;
/**
* Joining strategy that uses join columns
* <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 2.3
* @since 2.2
*
* @see {@link RelationshipMapping}
* @see {@link JoinColumnEnabledRelationshipReference}
*/
public interface JoinColumnJoiningStrategy
extends JoiningStrategy
{
void initializeFrom(JoinColumnJoiningStrategy oldStrategy);
/**
* The source of the relationship will usually be the owning type mapping.
* In the case of a target foreign key relationship the source and target
* are swapped.
* @see isTargetForeignKeyRelationship()
*/
TypeMapping getRelationshipSource();
/**
* The target of the relationship will usually be the target entity.
* In the case of a target foreign key relationship the source and target
* are swapped.
* @see isTargetForeignKeyRelationship()
*/
TypeMapping getRelationshipTarget();
/**
* Return whether this relationship is a target foreign key relationship.
* A one-to-many mapping with a join column will have the foreign key
* in the target table.
*/
boolean isTargetForeignKeyRelationship();
/**
* Return a list iterator of the join columns whether specified or default.
* This will not be null.
*/
<T extends JoinColumn> ListIterator<T> joinColumns();
/**
* Return the number of join columns, both specified and default.
*/
int joinColumnsSize();
/**
* Change notification identifier for "defaultJoinColumn" property
*/
String DEFAULT_JOIN_COLUMN_PROPERTY = "defaultJoinColumn"; //$NON-NLS-1$
/**
* Return the default join column or null. If there are specified join
* columns, then there will be no default join column (though there are
* times that there may be no default join column even if there are no
* specified join columns.)
*/
JoinColumn getDefaultJoinColumn();
/**
* Change notification identifier for "specifiedJoinColumns" list
*/
String SPECIFIED_JOIN_COLUMNS_LIST = "specifiedJoinColumns"; //$NON-NLS-1$
/**
* Return a list iterator of the specified join columns.
* This will not be null.
*/
<T extends JoinColumn> ListIterator<T> specifiedJoinColumns();
/**
* Return the number of specified join columns.
*/
int specifiedJoinColumnsSize();
/**
* Return whether this has any specified join columns.
* (Equivalent to {@link #specifiedJoinColumnsSize()} == 0)
*/
boolean hasSpecifiedJoinColumns();
/**
* Add a specified join column to the join table return the object
* representing it.
*/
JoinColumn addSpecifiedJoinColumn(int index);
/**
* Remove the specified join column from the join table.
*/
void removeSpecifiedJoinColumn(int index);
/**
* Remove the specified join column at the index from the join table.
*/
void removeSpecifiedJoinColumn(JoinColumn joinColumn);
/**
* Move the specified join column from the source index to the target index.
*/
void moveSpecifiedJoinColumn(int targetIndex, int sourceIndex);
}
|
