2 Copyright 2010, 2011, Oracle and/or its affiliates. All rights reserved.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; version 2 of the License.
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
13 You should have received a copy of the GNU General Public License
14 along with this program; if not, write to the Free Software
15 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 package com.mysql.clusterj;
20 public interface ColumnMetadata {
22 /** Return the name of the column.
23 * @return the name of the column
27 /** Return the type of the column.
28 * @return the type of the column
30 ColumnType columnType();
32 /** Return the java type of the column.
33 * @return the java type of the column
37 /** Return the maximum number of bytes that can be stored in the column
38 * after translating the characters using the character set.
39 * @return the maximum number of bytes that can be stored in the column
43 /** Return the column number. This number is used as the first parameter in
44 * the get and set methods of DynamicColumn.
45 * @return the column number.
49 /** Return whether this column is a primary key column.
50 * @return true if this column is a primary key column
52 boolean isPrimaryKey();
54 /** Return whether this column is a partition key column.
55 * @return true if this column is a partition key column
57 boolean isPartitionKey();
59 /** Return the precision of the column.
60 * @return the precision of the column
64 /** Return the scale of the column.
65 * @return the scale of the column
69 /** Return whether this column is nullable.
70 * @return whether this column is nullable
74 /** Return the charset name.
75 * @return the charset name