File Doc Category Size Date Package
Column.java API Doc Glassfish v2 API 5039 Fri May 04 22:34:06 BST 2007 javax.persistence

Column

public class Column

Is used to specify a mapped column for a persistent property or field. If no Column annotation is specified, the default values are applied.

Examples:

Example 1:
@Column(name="DESC", nullable=false, length=512)
public String getDescription() { return description; }

Example 2:
@Column(name="DESC",
columnDefinition="CLOB NOT NULL",
table="EMP_DETAIL")
@Lob
public String getDescription() { return description; }

Example 3:
@Column(name="ORDER_COST", updatable=false, precision=12, scale=2)
public BigDecimal getCost() { return cost; }

since: Java Persistence 1.0

Fields Summary
Constructors Summary
Methods Summary
java.lang.String columnDefinition()
(Optional) The SQL fragment that is used when generating the DDL for the column.
Defaults to the generated SQL to create a column of the inferred type.
boolean insertable()
(Optional) Whether the column is included in SQL INSERT statements generated by the persistence provider.
int length()
(Optional) The column length. (Applies only if a string-valued column is used.)
java.lang.String name()
(Optional) The name of the column. Defaults to the property or field name.
boolean nullable()
(Optional) Whether the database column is nullable.
int precision()
(Optional) The precision for a decimal (exact numeric) column. (Applies only if a decimal column is used.) Value must be set by developer if used when generating the DDL for the column.
int scale()
(Optional) The scale for a decimal (exact numeric) column. (Applies only if a decimal column is used.)
java.lang.String table()
(Optional) The name of the table that contains the column. If absent the column is assumed to be in the primary table.
boolean unique()
(Optional) Whether the property is a unique key. This is a shortcut for the UniqueConstraint annotation at the table level and is useful for when the unique key constraint is only a single field. This constraint applies in addition to any constraint entailed by primary key mapping and to constraints specified at the table level.
boolean updatable()
(Optional) Whether the column is included in SQL UPDATE statements generated by the persistence provider.