518 lines
16 KiB
HTML
518 lines
16 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="zh">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_65) on Thu Jan 21 13:52:14 CST 2016 -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>Column (RedKale的API文档)</title>
|
|
<meta name="date" content="2016-01-21">
|
|
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
<script type="text/javascript" src="../../script.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Column (RedKale\u7684API\u6587\u6863)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>您的浏览器已禁用 JavaScript。</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="导航">
|
|
<li><a href="../../overview-summary.html">概览</a></li>
|
|
<li><a href="package-summary.html">程序包</a></li>
|
|
<li class="navBarCell1Rev">类</li>
|
|
<li><a href="class-use/Column.html">使用</a></li>
|
|
<li><a href="package-tree.html">树</a></li>
|
|
<li><a href="../../deprecated-list.html">已过时</a></li>
|
|
<li><a href="../../index-files/index-1.html">索引</a></li>
|
|
<li><a href="../../help-doc.html">帮助</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../javax/persistence/Cacheable.html" title="javax.persistence中的注释"><span class="typeNameLink">上一个类</span></a></li>
|
|
<li><a href="../../javax/persistence/Entity.html" title="javax.persistence中的注释"><span class="typeNameLink">下一个类</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?javax/persistence/Column.html" target="_top">框架</a></li>
|
|
<li><a href="Column.html" target="_top">无框架</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../allclasses-noframe.html">所有类</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>概要: </li>
|
|
<li>字段 | </li>
|
|
<li>必需 | </li>
|
|
<li><a href="#annotation.type.optional.element.summary">可选</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>详细资料: </li>
|
|
<li>字段 | </li>
|
|
<li><a href="#annotation.type.element.detail">元素</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">javax.persistence</div>
|
|
<h2 title="注释类型 Column" class="title">注释类型 Column</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>@Target(value={METHOD,FIELD})
|
|
@Retention(value=RUNTIME)
|
|
public @interface <span class="memberNameLabel">Column</span></pre>
|
|
<div class="block">Specifies the mapped column for a persistent property or field.
|
|
If no <code>Column</code> annotation is specified, the default values apply.
|
|
|
|
<blockquote><pre>
|
|
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; }
|
|
|
|
</pre></blockquote></div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">从以下版本开始:</span></dt>
|
|
<dd>Java Persistence 1.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="annotation.type.optional.element.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>可选元素概要</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="可选元素概要表, 列表可选元素和解释">
|
|
<caption><span>可选元素</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">限定符和类型</th>
|
|
<th class="colLast" scope="col">可选元素和说明</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#columnDefinition--">columnDefinition</a></span></code>
|
|
<div class="block">(Optional) The SQL fragment that is used when
|
|
generating the DDL for the column.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#insertable--">insertable</a></span></code>
|
|
<div class="block">(Optional) Whether the column is included in SQL INSERT
|
|
statements generated by the persistence provider.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#length--">length</a></span></code>
|
|
<div class="block">(Optional) The column length.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#name--">name</a></span></code>
|
|
<div class="block">(Optional) The name of the column.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#nullable--">nullable</a></span></code>
|
|
<div class="block">(Optional) Whether the database column is nullable.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#precision--">precision</a></span></code>
|
|
<div class="block">(Optional) The precision for a decimal (exact numeric)
|
|
column.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#scale--">scale</a></span></code>
|
|
<div class="block">(Optional) The scale for a decimal (exact numeric) column.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#table--">table</a></span></code>
|
|
<div class="block">(Optional) The name of the table that contains the column.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#unique--">unique</a></span></code>
|
|
<div class="block">(Optional) Whether the column is a unique key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/persistence/Column.html#updatable--">updatable</a></span></code>
|
|
<div class="block">(Optional) Whether the column is included in SQL UPDATE
|
|
statements generated by the persistence provider.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="annotation.type.element.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>元素详细资料</h3>
|
|
<a name="name--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>name</h4>
|
|
<pre>public abstract java.lang.String name</pre>
|
|
<div class="block">(Optional) The name of the column. Defaults to
|
|
the property or field name.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>String</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>""</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="unique--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>unique</h4>
|
|
<pre>public abstract boolean unique</pre>
|
|
<div class="block">(Optional) Whether the column is a unique key. This is a
|
|
shortcut for the <code>UniqueConstraint</code> annotation at the table
|
|
level and is useful for when the unique key constraint
|
|
corresponds to only a single column. This constraint applies
|
|
in addition to any constraint entailed by primary key mapping and
|
|
to constraints specified at the table level.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>boolean</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>false</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="nullable--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>nullable</h4>
|
|
<pre>public abstract boolean nullable</pre>
|
|
<div class="block">(Optional) Whether the database column is nullable.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>boolean</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>true</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="insertable--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>insertable</h4>
|
|
<pre>public abstract boolean insertable</pre>
|
|
<div class="block">(Optional) Whether the column is included in SQL INSERT
|
|
statements generated by the persistence provider.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>boolean</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>true</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="updatable--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>updatable</h4>
|
|
<pre>public abstract boolean updatable</pre>
|
|
<div class="block">(Optional) Whether the column is included in SQL UPDATE
|
|
statements generated by the persistence provider.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>boolean</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>true</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="columnDefinition--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>columnDefinition</h4>
|
|
<pre>public abstract java.lang.String columnDefinition</pre>
|
|
<div class="block">(Optional) The SQL fragment that is used when
|
|
generating the DDL for the column.
|
|
<p>
|
|
Defaults to the generated SQL to create a
|
|
column of the inferred type.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>String</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>""</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="table--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>table</h4>
|
|
<pre>public abstract java.lang.String table</pre>
|
|
<div class="block">(Optional) The name of the table that contains the column.
|
|
If absent the column is assumed to be in the primary table.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>String</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>""</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="length--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>length</h4>
|
|
<pre>public abstract int length</pre>
|
|
<div class="block">(Optional) The column length. (Applies only if a
|
|
string-valued column is used.)</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>int</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>255</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="precision--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>precision</h4>
|
|
<pre>public abstract int precision</pre>
|
|
<div class="block">(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.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>int</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="scale--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>scale</h4>
|
|
<pre>public abstract int scale</pre>
|
|
<div class="block">(Optional) The scale for a decimal (exact numeric) column.
|
|
(Applies only if a decimal column is used.)</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">返回:</span></dt>
|
|
<dd>int</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>默认值:</dt>
|
|
<dd>0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="导航">
|
|
<li><a href="../../overview-summary.html">概览</a></li>
|
|
<li><a href="package-summary.html">程序包</a></li>
|
|
<li class="navBarCell1Rev">类</li>
|
|
<li><a href="class-use/Column.html">使用</a></li>
|
|
<li><a href="package-tree.html">树</a></li>
|
|
<li><a href="../../deprecated-list.html">已过时</a></li>
|
|
<li><a href="../../index-files/index-1.html">索引</a></li>
|
|
<li><a href="../../help-doc.html">帮助</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../javax/persistence/Cacheable.html" title="javax.persistence中的注释"><span class="typeNameLink">上一个类</span></a></li>
|
|
<li><a href="../../javax/persistence/Entity.html" title="javax.persistence中的注释"><span class="typeNameLink">下一个类</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?javax/persistence/Column.html" target="_top">框架</a></li>
|
|
<li><a href="Column.html" target="_top">无框架</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../allclasses-noframe.html">所有类</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>概要: </li>
|
|
<li>字段 | </li>
|
|
<li>必需 | </li>
|
|
<li><a href="#annotation.type.optional.element.summary">可选</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>详细资料: </li>
|
|
<li>字段 | </li>
|
|
<li><a href="#annotation.type.element.detail">元素</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|