blob: 05949d23e2394b6d810871ea9e8dd5e18ffe3745 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:09 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Embeddable (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<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="Embeddable (OpenJPA Parent POM 3.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/Embeddable.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="../../../../../org/apache/openjpa/jdbc/meta/DiscriminatorStrategy.html" title="interface in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/Embeddable.html" target="_top">Frames</a></li>
<li><a href="Embeddable.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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">org.apache.openjpa.jdbc.meta</div>
<h2 title="Interface Embeddable" class="title">Interface Embeddable</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">EmbedFieldStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/HandlerFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">HandlerFieldStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/MaxEmbeddedBlobFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">MaxEmbeddedBlobFieldStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/MaxEmbeddedByteArrayFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">MaxEmbeddedByteArrayFieldStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/MaxEmbeddedCharArrayFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">MaxEmbeddedCharArrayFieldStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/MaxEmbeddedClobFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">MaxEmbeddedClobFieldStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/PrimitiveFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">PrimitiveFieldStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/RelationFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">RelationFieldStrategy</a>, <a href="../../../../../org/apache/openjpa/jdbc/meta/strats/StringFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats">StringFieldStrategy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Embeddable</span></pre>
<div class="block">Interface for field strategies that can managed fields of
embedded-element, embedded-key, and embedded-value objects. Fields of
directly embedded objects do not have to implement this interface.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.4.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Abe White</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#UNSUPPORTED">UNSUPPORTED</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#getColumnIO--">getColumnIO</a></span>()</code>
<div class="block">Return column I/O information for this mapping.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#getColumns--">getColumns</a></span>()</code>
<div class="block">Return the columns used by this strategy.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#getResultArguments--">getResultArguments</a></span>()</code>
<div class="block">Return the arguments needed to extract datastore values via
<a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html#getObject-java.lang.Object-int-java.lang.Object-"><code>Result.getObject(java.lang.Object, int, java.lang.Object)</code></a> for each column.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#loadEmbedded-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-java.lang.Object-">loadEmbedded</a></span>(<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</code>
<div class="block">Load this strategy's field by transforming the given datastore value.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#toEmbeddedDataStoreValue-java.lang.Object-org.apache.openjpa.jdbc.kernel.JDBCStore-">toEmbeddedDataStoreValue</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store)</code>
<div class="block">Convert the given Java value to its datastore equivalent.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#toEmbeddedObjectValue-java.lang.Object-">toEmbeddedObjectValue</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</code>
<div class="block">Convert the given datastore value to its Java equivalent.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="UNSUPPORTED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UNSUPPORTED</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> UNSUPPORTED</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getColumns--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumns</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]&nbsp;getColumns()</pre>
<div class="block">Return the columns used by this strategy.</div>
</li>
</ul>
<a name="getColumnIO--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnIO</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</a>&nbsp;getColumnIO()</pre>
<div class="block">Return column I/O information for this mapping.</div>
</li>
</ul>
<a name="getResultArguments--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResultArguments</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]&nbsp;getResultArguments()</pre>
<div class="block">Return the arguments needed to extract datastore values via
<a href="../../../../../org/apache/openjpa/jdbc/sql/Result.html#getObject-java.lang.Object-int-java.lang.Object-"><code>Result.getObject(java.lang.Object, int, java.lang.Object)</code></a> for each column.</div>
</li>
</ul>
<a name="toEmbeddedDataStoreValue-java.lang.Object-org.apache.openjpa.jdbc.kernel.JDBCStore-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toEmbeddedDataStoreValue</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;toEmbeddedDataStoreValue(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store)</pre>
<div class="block">Convert the given Java value to its datastore equivalent. If this
mapping occupies multiple columns, return an object array with one
element per column. For relation id columns, return the state manager
the column depends on.</div>
</li>
</ul>
<a name="toEmbeddedObjectValue-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toEmbeddedObjectValue</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;toEmbeddedObjectValue(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</pre>
<div class="block">Convert the given datastore value to its Java equivalent.
If <a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#getColumns--"><code>getColumns()</code></a> returns multiple columns, the given datastore
value will be an object array of the corresponding length. This method
must only be supported by mappings of embedded id objects. In other
cases <a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#loadEmbedded-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-java.lang.Object-"><code>loadEmbedded(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, java.lang.Object)</code></a> will be used instead. Return
<a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#UNSUPPORTED"><code>UNSUPPORTED</code></a> if this mapping cannot support this method.</div>
</li>
</ul>
<a name="loadEmbedded-org.apache.openjpa.kernel.OpenJPAStateManager-org.apache.openjpa.jdbc.kernel.JDBCStore-org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>loadEmbedded</h4>
<pre>void&nbsp;loadEmbedded(<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</a>&nbsp;store,
<a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</a>&nbsp;fetch,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Load this strategy's field by transforming the given datastore value.
If <a href="../../../../../org/apache/openjpa/jdbc/meta/Embeddable.html#getColumns--"><code>getColumns()</code></a> returns multiple columns, the given datastore
value will be an object array of the corresponding length. The value
does not have to be loaded immediately; it may be stored as impl data.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></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/Embeddable.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="../../../../../org/apache/openjpa/jdbc/meta/DiscriminatorStrategy.html" title="interface in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/meta/Embeddable.html" target="_top">Frames</a></li>
<li><a href="Embeddable.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>