blob: b502f61ca692cd55f34716d432fa04b142a0667c (
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
|
/*******************************************************************************
* Copyright (c) 2008 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.db;
import org.eclipse.jpt.utility.JavaType;
/**
* Database column
*
* 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.
*
* This interface is not intended to be implemented by clients.
*/
public interface Column
extends DatabaseObject, Comparable<Column>
{
/**
* Return the column's table.
*/
Table getTable();
// ********** constraints **********
/**
* Return whether the column is part of it's table's primary key.
*/
boolean isPartOfPrimaryKey();
/**
* Return whether the column is part of one of it's table's foreign keys.
*/
boolean isPartOfForeignKey();
/**
* Return whether the column is part of a unique constraint defined for its
* table.
*/
boolean isPartOfUniqueConstraint();
/**
* Return whether the column is nullable.
*/
boolean isNullable();
// ********** data type **********
/**
* Return the name of the column's datatype.
*/
String getDataTypeName();
/**
* Return whether the column's type is numeric.
*/
boolean isNumeric();
/**
* Return the column's precision if it is a NumericalDataType;
* otherwise, return -1.
*/
public int getPrecision();
/**
* Return the column's scale if it is an ExactNumericDataType;
* otherwise, return -1.
*/
public int getScale();
/**
* If the column is a CharacterStringDataType, return its length;
* otherwise, return -1.
*/
public int getLength();
/**
* Return whether the column's datatype is a LOB type
* (i.e. BLOB, CLOB, or NCLOB).
*/
boolean isLOB();
// ********** Java type **********
/**
* Return a Java type declaration that is reasonably
* similar to the column's data type.
*/
String getJavaTypeDeclaration();
/**
* Return a Java type that is reasonably
* similar to the column's data type.
*/
JavaType getJavaType();
/**
* Return a Java type declaration that is reasonably
* similar to the column's data type and suitable for use as a
* primary key field.
*/
String getPrimaryKeyJavaTypeDeclaration();
/**
* Return a Java type that is reasonably
* similar to the column's data type and suitable for use as a
* primary key field.
*/
JavaType getPrimaryKeyJavaType();
}
|
