blob: 5e77cc046b8445531bdc425818d5f33f65c14013 (
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/*******************************************************************************
* Copyright (c) 2007, 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.jpa.core.resource.java;
import java.util.ListIterator;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jpt.common.core.utility.TextRange;
/**
* Corresponds to the JPA annotation
* javax.persistence.TableGenerator
*
* 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.1
* @since 2.0
*/
public interface TableGeneratorAnnotation
extends GeneratorAnnotation
{
String ANNOTATION_NAME = JPA.TABLE_GENERATOR;
/**
* Corresponds to the 'table' element of the TableGenerator annotation.
* Return null if the element does not exist in Java.
*/
String getTable();
String TABLE_PROPERTY = "table"; //$NON-NLS-1$
/**
* Corresponds to the 'table' element of the TableGenerator annotation.
* Set to null to remove the element.
*/
void setTable(String table);
/**
* Return the {@link TextRange} for the 'table' element. If the element
* does not exist return the {@link TextRange} for the TableGenerator annotation.
*/
TextRange getTableTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'table' element.
* Return false if the element does not exist.
*/
boolean tableTouches(int pos, CompilationUnit astRoot);
/**
* Corresponds to the 'schema' element of the TableGenerator annotation.
* Return null if the element does not exist in Java.
*/
String getSchema();
String SCHEMA_PROPERTY = "schema"; //$NON-NLS-1$
/**
* Corresponds to the 'schema' element of the TableGenerator annotation.
* Set to null to remove the element.
*/
void setSchema(String schema);
/**
* Return the {@link TextRange} for the 'schema' element. If the element
* does not exist return the {@link TextRange} for the TableGenerator annotation.
*/
TextRange getSchemaTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'schema' element.
* Return false if the element does not exist.
*/
boolean schemaTouches(int pos, CompilationUnit astRoot);
/**
* Corresponds to the 'catalog' element of the TableGenerator annotation.
* Return null if the element does not exist in Java.
*/
String getCatalog();
String CATALOG_PROPERTY = "catalog"; //$NON-NLS-1$
/**
* Corresponds to the 'catalog' element of the TableGenerator annotation.
* Set to null to remove the element.
*/
void setCatalog(String catalog);
/**
* Return the {@link TextRange} for the 'catalog' element. If the element
* does not exist return the {@link TextRange} for the TableGenerator annotation.
*/
TextRange getCatalogTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'catalog' element.
* Return false if the element does not exist.
*/
boolean catalogTouches(int pos, CompilationUnit astRoot);
/**
* Corresponds to the 'pkColumnName' element of the TableGenerator annotation.
* Return null if the element does not exist in Java.
*/
String getPkColumnName();
String PK_COLUMN_NAME_PROPERTY = "pkColumnName"; //$NON-NLS-1$
/**
* Corresponds to the 'pkColumnName' element of the TableGenerator annotation.
* Set to null to remove the element.
*/
void setPkColumnName(String pkColumnName);
/**
* Return the {@link TextRange} for the 'pkColumnName' element. If the element
* does not exist return the {@link TextRange} for the TableGenerator annotation.
*/
TextRange getPkColumnNameTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'pkColumnName' element.
* Return false if the element does not exist.
*/
boolean pkColumnNameTouches(int pos, CompilationUnit astRoot);
/**
* Corresponds to the 'valueColumnName' element of the TableGenerator annotation.
* Return null if the element does not exist in Java.
*/
String getValueColumnName();
String VALUE_COLUMN_NAME_PROPERTY = "valueColumnName"; //$NON-NLS-1$
/**
* Corresponds to the 'valueColumnName' element of the TableGenerator annotation.
* Set to null to remove the element.
*/
void setValueColumnName(String valueColumnName);
/**
* Return the {@link TextRange} for the 'valueColumnName' element. If the element
* does not exist return the {@link TextRange} for the TableGenerator annotation.
*/
TextRange getValueColumnNameTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'valueColumnName' element.
* Return false if the element does not exist.
*/
boolean valueColumnNameTouches(int pos, CompilationUnit astRoot);
/**
* Corresponds to the 'pkColumnValue' element of the TableGenerator annotation.
* Return null if the element does not exist in Java.
*/
String getPkColumnValue();
String PK_COLUMN_VALUE_PROPERTY = "pkColumnValue"; //$NON-NLS-1$
/**
* Corresponds to the 'pkColumnValue' element of the TableGenerator annotation.
* Set to null to remove the element.
*/
void setPkColumnValue(String pkColumnValue);
/**
* Return the {@link TextRange} for the 'pkColumnValue' element. If the element
* does not exist return the {@link TextRange} for the TableGenerator annotation.
*/
TextRange getPkColumnValueTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'pkColumnValue' element.
* Return false if the element does not exist.
*/
boolean pkColumnValueTouches(int pos, CompilationUnit astRoot);
/**
* Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
* Return null if the element does not exist in Java.
*/
ListIterator<UniqueConstraintAnnotation> uniqueConstraints();
String UNIQUE_CONSTRAINTS_LIST = "uniqueConstraints"; //$NON-NLS-1$
/**
* Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
*/
int uniqueConstraintsSize();
/**
* Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
*/
UniqueConstraintAnnotation uniqueConstraintAt(int index);
/**
* Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
*/
int indexOfUniqueConstraint(UniqueConstraintAnnotation uniqueConstraint);
/**
* Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
*/
UniqueConstraintAnnotation addUniqueConstraint(int index);
/**
* Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
*/
void moveUniqueConstraint(int targetIndex, int sourceIndex);
/**
* Corresponds to the 'uniqueConstraints' element of the TableGenerator annotation.
*/
void removeUniqueConstraint(int index);
}
|
