blob: 4cdd7074c45ef2bb43d3eaa17dacaff5bbdd4d6e (
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
|
/*******************************************************************************
* Copyright (c) 2007, 2012 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.core.utility.TextRange;
import org.eclipse.jpt.jpa.core.internal.context.JptValidator;
import org.eclipse.jpt.jpa.db.Table;
/**
* Read-only
* <ul>
* <li>column
* <li>join column
* <li>primary key join column
* <li>discriminator column
* <li>order column
* </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.
*/
public interface ReadOnlyNamedColumn
extends JpaContextNode
{
// ********** name **********
/**
* Return the specified name if present, otherwise return the default
* name.
*/
String getName();
String getSpecifiedName();
String SPECIFIED_NAME_PROPERTY = "specifiedName"; //$NON-NLS-1$
String getDefaultName();
String DEFAULT_NAME_PROPERTY = "defaultName"; //$NON-NLS-1$
/**
* Return the (best guess) text location of the column's name.
*/
TextRange getNameTextRange();
// ********** table **********
/**
* Return the name of the column's table. A column that does not have a
* <em>specified</em> table still has a table (as determined by
* the column's owner).
*/
String getTable();
// ********** column definition **********
String getColumnDefinition();
String COLUMN_DEFINITION_PROPERTY = "columnDefinition"; //$NON-NLS-1$
// ********** database stuff **********
/**
* Return the column's datasource table.
*/
Table getDbTable();
/**
* Return whether the column is found on the datasource.
*/
boolean isResolved();
// ********** misc **********
/**
* Return whether the column has a textual representation
* in its underlying resource.
*/
boolean isVirtual();
// ********** owner **********
/**
* Interface allowing columns to be used in multiple places
* (e.g. basic mappings and attribute overrides).
*/
interface Owner
{
/**
* Return the name of the table which the column belongs to by default.
*/
String getDefaultTableName();
/**
* Return the default column name.
*/
String getDefaultColumnName(ReadOnlyNamedColumn column);
/**
* Return the database table for the specified table name.
*/
Table resolveDbTable(String tableName);
JptValidator buildColumnValidator(ReadOnlyNamedColumn column);
/**
* Return the column owner's text range. This can be returned by the
* column when its annotation is not present.
*/
TextRange getValidationTextRange();
}
}
|
