Google Git
Sign in
apache / db-jdo-site / refs/heads/publish / . / content / api321 / apidocs / javax / jdo / metadata / PropertyMetadata.html
blob: f836146385d3d48ab0d2555d816ffb20f12f4a2a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PropertyMetadata (JDO API 3.2.1)</title>
<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="PropertyMetadata (JDO API 3.2.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PropertyMetadata.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../javax/jdo/metadata/PrimaryKeyMetadata.html" title="interface in javax.jdo.metadata"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/metadata/QueryMetadata.html" title="interface in javax.jdo.metadata"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/metadata/PropertyMetadata.html" target="_top">Frames</a></li>
<li><a href="PropertyMetadata.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</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>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</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.jdo.metadata</div>
<h2 title="Interface PropertyMetadata" class="title">Interface PropertyMetadata</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../javax/jdo/metadata/MemberMetadata.html" title="interface in javax.jdo.metadata">MemberMetadata</a>, <a href="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PropertyMetadata</span>
extends <a href="../../../javax/jdo/metadata/MemberMetadata.html" title="interface in javax.jdo.metadata">MemberMetadata</a></pre>
<div class="block">Represents a property in a class/persistent-interface.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/metadata/PropertyMetadata.html#getFieldName--">getFieldName</a></span>()</code>
<div class="block">Accessor for the field name.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/jdo/metadata/PropertyMetadata.html" title="interface in javax.jdo.metadata">PropertyMetadata</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/jdo/metadata/PropertyMetadata.html#setFieldName-java.lang.String-">setFieldName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Method to set the field name (persistent interfaces).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.jdo.metadata.MemberMetadata">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.jdo.metadata.<a href="../../../javax/jdo/metadata/MemberMetadata.html" title="interface in javax.jdo.metadata">MemberMetadata</a></h3>
<code><a href="../../../javax/jdo/metadata/MemberMetadata.html#getArrayMetadata--">getArrayMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getCacheable--">getCacheable</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getCollectionMetadata--">getCollectionMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getColumn--">getColumn</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getColumns--">getColumns</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getConverter--">getConverter</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getCustomStrategy--">getCustomStrategy</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getDefaultFetchGroup--">getDefaultFetchGroup</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getDeleteAction--">getDeleteAction</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getDependent--">getDependent</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getElementMetadata--">getElementMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getEmbedded--">getEmbedded</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getEmbeddedMetadata--">getEmbeddedMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getFieldType--">getFieldType</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getForeignKeyMetadata--">getForeignKeyMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getIndexed--">getIndexed</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getIndexMetadata--">getIndexMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getJoinMetadata--">getJoinMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getKeyMetadata--">getKeyMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getLoadFetchGroup--">getLoadFetchGroup</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getMapMetadata--">getMapMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getMappedBy--">getMappedBy</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getName--">getName</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getNullValue--">getNullValue</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getNumberOfColumns--">getNumberOfColumns</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getOrderMetadata--">getOrderMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getPersistenceModifier--">getPersistenceModifier</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getPrimaryKey--">getPrimaryKey</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getRecursionDepth--">getRecursionDepth</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getSequence--">getSequence</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getSerialized--">getSerialized</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getTable--">getTable</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getUnique--">getUnique</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getUniqueMetadata--">getUniqueMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getUseDefaultConversion--">getUseDefaultConversion</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getValueMetadata--">getValueMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#getValueStrategy--">getValueStrategy</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newArrayMetadata--">newArrayMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newCollectionMetadata--">newCollectionMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newColumnMetadata--">newColumnMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newElementMetadata--">newElementMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newEmbeddedMetadata--">newEmbeddedMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newForeignKeyMetadata--">newForeignKeyMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newIndexMetadata--">newIndexMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newJoinMetadata--">newJoinMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newKeyMetadata--">newKeyMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newMapMetadata--">newMapMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newOrderMetadata--">newOrderMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newUniqueMetadata--">newUniqueMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#newValueMetadata--">newValueMetadata</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setCacheable-boolean-">setCacheable</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setColumn-java.lang.String-">setColumn</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setConverter-javax.jdo.AttributeConverter-">setConverter</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setCustomStrategy-java.lang.String-">setCustomStrategy</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setDefaultFetchGroup-boolean-">setDefaultFetchGroup</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setDeleteAction-javax.jdo.annotations.ForeignKeyAction-">setDeleteAction</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setDependent-boolean-">setDependent</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setEmbedded-boolean-">setEmbedded</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setFieldType-java.lang.String-">setFieldType</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setIndexed-boolean-">setIndexed</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setLoadFetchGroup-java.lang.String-">setLoadFetchGroup</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setMappedBy-java.lang.String-">setMappedBy</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setName-java.lang.String-">setName</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setNullValue-javax.jdo.annotations.NullValue-">setNullValue</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setPersistenceModifier-javax.jdo.annotations.PersistenceModifier-">setPersistenceModifier</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setPrimaryKey-boolean-">setPrimaryKey</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setRecursionDepth-int-">setRecursionDepth</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setSequence-java.lang.String-">setSequence</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setSerialized-boolean-">setSerialized</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setTable-java.lang.String-">setTable</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setUnique-boolean-">setUnique</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setUseDefaultConversion-java.lang.Boolean-">setUseDefaultConversion</a>, <a href="../../../javax/jdo/metadata/MemberMetadata.html#setValueStrategy-javax.jdo.annotations.IdGeneratorStrategy-">setValueStrategy</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.jdo.metadata.Metadata">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.jdo.metadata.<a href="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</a></h3>
<code><a href="../../../javax/jdo/metadata/Metadata.html#getExtensions--">getExtensions</a>, <a href="../../../javax/jdo/metadata/Metadata.html#getNumberOfExtensions--">getNumberOfExtensions</a>, <a href="../../../javax/jdo/metadata/Metadata.html#getParent--">getParent</a>, <a href="../../../javax/jdo/metadata/Metadata.html#newExtensionMetadata-java.lang.String-java.lang.String-java.lang.String-">newExtensionMetadata</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setFieldName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFieldName</h4>
<pre><a href="../../../javax/jdo/metadata/PropertyMetadata.html" title="interface in javax.jdo.metadata">PropertyMetadata</a>&nbsp;setFieldName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Method to set the field name (persistent interfaces).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - field name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This metadata object</dd>
</dl>
</li>
</ul>
<a name="getFieldName--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFieldName</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getFieldName()</pre>
<div class="block">Accessor for the field name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Field name</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="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PropertyMetadata.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../javax/jdo/metadata/PrimaryKeyMetadata.html" title="interface in javax.jdo.metadata"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/jdo/metadata/QueryMetadata.html" title="interface in javax.jdo.metadata"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/jdo/metadata/PropertyMetadata.html" target="_top">Frames</a></li>
<li><a href="PropertyMetadata.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</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>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2005&#x2013;2022 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>