001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036: package javax.persistence;
037:
038: import java.lang.annotation.Target;
039: import java.lang.annotation.Retention;
040: import static java.lang.annotation.ElementType.METHOD;
041: import static java.lang.annotation.ElementType.FIELD;
042: import static java.lang.annotation.RetentionPolicy.RUNTIME;
043:
044: /**
045: * Is used to specify a mapped column for a persistent property or field.
046: * If no Column annotation is specified, the default values are applied.
047: * <p> Examples:
048: *
049: * <blockquote><pre>
050: * Example 1:
051: * @Column(name="DESC", nullable=false, length=512)
052: * public String getDescription() { return description; }
053: *
054: * Example 2:
055: * @Column(name="DESC",
056: * columnDefinition="CLOB NOT NULL",
057: * table="EMP_DETAIL")
058: * @Lob
059: * public String getDescription() { return description; }
060: *
061: * Example 3:
062: * @Column(name="ORDER_COST", updatable=false, precision=12, scale=2)
063: * public BigDecimal getCost() { return cost; }
064: *
065: * </pre></blockquote>
066: *
067: *
068: * @since Java Persistence 1.0
069: */
070: @Target({METHOD,FIELD})
071: @Retention(RUNTIME)
072: public @interface Column {
073:
074: /**
075: * (Optional) The name of the column. Defaults to
076: * the property or field name.
077: */
078: String name() default "";
079:
080: /**
081: * (Optional) Whether the property is a unique key. This is a
082: * shortcut for the UniqueConstraint annotation at the table
083: * level and is useful for when the unique key constraint is
084: * only a single field. This constraint applies in addition
085: * to any constraint entailed by primary key mapping and
086: * to constraints specified at the table level.
087: */
088: boolean unique() default false;
089:
090: /**
091: * (Optional) Whether the database column is nullable.
092: */
093: boolean nullable() default true;
094:
095: /**
096: * (Optional) Whether the column is included in SQL INSERT
097: * statements generated by the persistence provider.
098: */
099: boolean insertable() default true;
100:
101: /**
102: * (Optional) Whether the column is included in SQL UPDATE
103: * statements generated by the persistence provider.
104: */
105: boolean updatable() default true;
106:
107: /**
108: * (Optional) The SQL fragment that is used when
109: * generating the DDL for the column.
110: * <p> Defaults to the generated SQL to create a
111: * column of the inferred type.
112: */
113: String columnDefinition() default "";
114:
115: /**
116: * (Optional) The name of the table that contains the column.
117: * If absent the column is assumed to be in the primary table.
118: */
119: String table() default "";
120:
121: /**
122: * (Optional) The column length. (Applies only if a
123: * string-valued column is used.)
124: */
125: int length() default 255;
126:
127: /**
128: * (Optional) The precision for a decimal (exact numeric)
129: * column. (Applies only if a decimal column is used.)
130: * Value must be set by developer if used when generating
131: * the DDL for the column.
132: */
133: int precision() default 0;
134:
135: /**
136: * (Optional) The scale for a decimal (exact numeric) column.
137: * (Applies only if a decimal column is used.)
138: */
139: int scale() default 0;
140: }
|