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
|
/*
Copyright (c) 2013 James Ahlborn
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA
*/
package com.healthmarketscience.jackcess;
import java.io.IOException;
import java.sql.SQLException;
import java.util.Map;
import com.healthmarketscience.jackcess.complex.ComplexColumnInfo;
import com.healthmarketscience.jackcess.complex.ComplexValue;
/**
* Access database column definition. A {@link Table} has a list of Column
* instances describing the table schema.
* <p>
* A Column instance is not thread-safe (see {@link Database} for more
* thread-safety details).
*
* @author James Ahlborn
*/
public interface Column
{
/**
* Meaningless placeholder object for inserting values in an autonumber
* column. it is not required that this value be used (any passed in value
* is ignored), but using this placeholder may make code more obvious.
* @usage _general_field_
*/
public static final Object AUTO_NUMBER = "<AUTO_NUMBER>";
/**
* Meaningless placeholder object for updating rows which indicates that a
* given column should keep its existing value.
* @usage _general_field_
*/
public static final Object KEEP_VALUE = "<KEEP_VALUE>";
/**
* @usage _general_method_
*/
public Table getTable();
/**
* @usage _general_method_
*/
public Database getDatabase();
/**
* @usage _general_method_
*/
public String getName();
/**
* @usage _advanced_method_
*/
public boolean isVariableLength();
/**
* @usage _general_method_
*/
public boolean isAutoNumber();
/**
* @usage _advanced_method_
*/
public int getColumnIndex();
/**
* @usage _general_method_
*/
public DataType getType();
/**
* @usage _general_method_
*/
public int getSQLType() throws SQLException;
/**
* @usage _general_method_
*/
public boolean isCompressedUnicode();
/**
* @usage _general_method_
*/
public byte getPrecision();
/**
* @usage _general_method_
*/
public byte getScale();
/**
* @usage _general_method_
*/
public short getLength();
/**
* @usage _general_method_
*/
public short getLengthInUnits();
/**
* Whether or not this column is "append only" (its history is tracked by a
* separate version history column).
* @usage _general_method_
*/
public boolean isAppendOnly();
/**
* Returns whether or not this is a hyperlink column (only possible for
* columns of type MEMO).
* @usage _general_method_
*/
public boolean isHyperlink();
/**
* Returns extended functionality for "complex" columns.
* @usage _general_method_
*/
public ComplexColumnInfo<? extends ComplexValue> getComplexInfo();
/**
* @return the properties for this column
* @usage _general_method_
*/
public PropertyMap getProperties() throws IOException;
/**
* Returns the column which tracks the version history for an "append only"
* column.
* @usage _intermediate_method_
*/
public Column getVersionHistoryColumn();
public Object setRowValue(Object[] rowArray, Object value);
public Object setRowValue(Map<String,Object> rowMap, Object value);
public Object getRowValue(Object[] rowArray);
public Object getRowValue(Map<String,?> rowMap);
}
|
