blob: 9db0d8e3d2f77ea6edd459272286994cc48a4859 (
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
154
155
156
157
|
/*******************************************************************************
* Copyright (c) 2008, 2009 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.db;
import java.util.Comparator;
import com.ibm.icu.text.Collator;
/**
* Database foreign key
* <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.
*/
public interface ForeignKey extends DatabaseObject {
// ********** tables **********
/**
* Return the foreign key's "base" table.
*/
Table getBaseTable();
/**
* Return the foreign key's "referenced" table.
*/
Table getReferencedTable();
// ********** column pairs **********
/**
* Return the foreign key's column pairs.
*/
Iterable<ColumnPair> getColumnPairs();
/**
* Return the size of the foreign key's column pairs.
*/
int getColumnPairsSize();
/**
* Return the foreign key's single column pair. Throw an
* {@link IllegalStateException} if the foreign key has more than one column pair.
*/
ColumnPair getColumnPair();
/**
* Return the foreign key's "base" columns.
*/
Iterable<Column> getBaseColumns();
/**
* Return the foreign key's "base" columns that are not part of the base
* table's primary key. (The non-primary key base columns are not used to
* generate basic attributes during entity generation.)
*/
Iterable<Column> getNonPrimaryKeyBaseColumns();
/**
* Return the foreign key's "referenced" columns.
*/
Iterable<Column> getReferencedColumns();
/**
* Return whether the foreign key references the primary key of the
* "referenced" table and that primary key has only a single column.
* This can be used when determining JPA defaults.
*/
boolean referencesSingleColumnPrimaryKey();
// ********** JPA support **********
/**
* Return an appropriate name for an attribute that holds the entity
* mapped to the foreign key's "referenced" table.
*/
String getAttributeName();
/**
* If the name of the "base" column adheres to the JPA spec for a
* default mapping (i.e. it ends with an underscore followed by the name
* of the "referenced" column, and the "referenced" column is the single
* primary key column of the "referenced" table), return the corresponding
* default attribute name:<pre>
* ForeignKey(EMP.CUBICLE_ID => CUBICLE.ID) => "CUBICLE"
* </pre>
* Return a <code>null</code> if it does not adhere to the JPA spec:<pre>
* ForeignKey(EMP.CUBICLE_ID => CUBICLE.CUBICLE_ID) => null
* ForeignKey(EMP.CUBICLE => CUBICLE.ID) => null
* </pre>
*/
String getDefaultAttributeName();
/**
* Given the name of an attribute (field or property) that is mapped to the
* foreign key,
* build and return a string to be used as the value for the attribute's
* <code>@javax.persistence.JoinColumn</code> annotation's <code>name</code> element.
* Return <code>null</code> if the attribute
* maps to the join column by default.
* <p>
* Precondition: The foreign key consists of a single column pair whose
* referenced column is the single-column primary key of the foreign
* key's referenced table.
* <p>
* This is used by the old entity generation code to determine whether
* a generated annotation must explicitly identify the join column
* or the calculated default adequately identifies the join column
* (taking into consideration case-sensitivity and special characters).
*/
String getJoinColumnAnnotationIdentifier(String attributeName);
// ********** column pair interface **********
/**
* Pair up the foreign key's column pairs, matching each "base" column with
* the appropriate "referenced" column.
* @see #columnPairs()
*/
interface ColumnPair {
/**
* Return the column pair's "base" column.
*/
Column getBaseColumn();
/**
* Return the column pair's "referenced" column.
*/
Column getReferencedColumn();
Comparator<ColumnPair> BASE_COLUMN_COMPARATOR =
new Comparator<ColumnPair>() {
public int compare(ColumnPair cp1, ColumnPair cp2) {
return Collator.getInstance().compare(cp1.getBaseColumn().getName(), cp2.getBaseColumn().getName());
}
@Override
public String toString() {
return "ForeignKey.ColumnPair.BASE_COLUMN_COMPARATOR"; //$NON-NLS-1$
}
};
}
}
|
