| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_15) on Fri Mar 13 09:15:48 CDT 2009 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| ElementEmbedValueHandler (OpenJPA 1.2.1 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.jdbc.meta.strats.ElementEmbedValueHandler class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ElementEmbedValueHandler (OpenJPA 1.2.1 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ElementEmbedValueHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/ContainerFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/EmbeddedClassStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ElementEmbedValueHandler.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.openjpa.jdbc.meta.strats</FONT> |
| <BR> |
| Class ElementEmbedValueHandler</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">org.apache.openjpa.jdbc.meta.strats.AbstractValueHandler</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">org.apache.openjpa.jdbc.meta.strats.EmbedValueHandler</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.jdbc.meta.strats.ElementEmbedValueHandler</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A>, <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/RelationId.html" title="interface in org.apache.openjpa.jdbc.meta">RelationId</A>, <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>ElementEmbedValueHandler</B><DT>extends <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">EmbedValueHandler</A><DT>implements <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/RelationId.html" title="interface in org.apache.openjpa.jdbc.meta">RelationId</A></DL> |
| </PRE> |
| |
| <P> |
| <p>Handler for embedded objects as elements of a collection or map. For |
| embedded objects as fields, use the more powerful |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats"><CODE>EmbedFieldStrategy</CODE></A>.</p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.4.0, 1.1.0</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Abe White</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../serialized-form.html#org.apache.openjpa.jdbc.meta.strats.ElementEmbedValueHandler">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html#ElementEmbedValueHandler()">ElementEmbedValueHandler</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html#getResultArgument(org.apache.openjpa.jdbc.meta.ValueMapping)">getResultArgument</A></B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm)</CODE> |
| |
| <BR> |
| Return the argument to pass to the result set when loading data |
| 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>, or null if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html#map(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.String, org.apache.openjpa.jdbc.schema.ColumnIO, boolean)">map</A></B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</A> io, |
| boolean adapt)</CODE> |
| |
| <BR> |
| Map the given value and return all mapped columns, or simply return an |
| array of unmapped default columns.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html#objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)">objectValueRequiresLoad</A></B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm)</CODE> |
| |
| <BR> |
| Return whether this handler potentially must load extra data to extract |
| the object value from its datastore representation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html#toDataStoreValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.jdbc.kernel.JDBCStore)">toDataStoreValue</A></B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</A> store)</CODE> |
| |
| <BR> |
| Translate the given value to its datastore equivalent.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html#toObjectValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)">toObjectValue</A></B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val, |
| <A HREF="../../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</A> store, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</A> fetch)</CODE> |
| |
| <BR> |
| Translate the given datastore value into its Java equivalent.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html#toRelationDataStoreValue(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.schema.Column)">toRelationDataStoreValue</A></B>(<A HREF="../../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</CODE> |
| |
| <BR> |
| Return the serialized value for the given related object, now that |
| its id has been assigned.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.jdbc.meta.strats.EmbedValueHandler"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.openjpa.jdbc.meta.strats.<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">EmbedValueHandler</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedValueHandler.html#map(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.String, org.apache.openjpa.jdbc.schema.ColumnIO, boolean, java.util.List, java.util.List)">map</A>, <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedValueHandler.html#toDataStoreValue(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.meta.ValueMapping, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.schema.Column[], java.lang.Object, int)">toDataStoreValue</A>, <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedValueHandler.html#toObjectValue(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration, org.apache.openjpa.jdbc.schema.Column[], int)">toObjectValue</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.jdbc.meta.strats.AbstractValueHandler"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.openjpa.jdbc.meta.strats.<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">AbstractValueHandler</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html#isVersionable(org.apache.openjpa.jdbc.meta.ValueMapping)">isVersionable</A>, <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html#toObjectValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object)">toObjectValue</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="ElementEmbedValueHandler()"><!-- --></A><H3> |
| ElementEmbedValueHandler</H3> |
| <PRE> |
| public <B>ElementEmbedValueHandler</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="map(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.String, org.apache.openjpa.jdbc.schema.ColumnIO, boolean)"><!-- --></A><H3> |
| map</H3> |
| <PRE> |
| public <A HREF="../../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] <B>map</B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</A> io, |
| boolean adapt)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#map(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.String, org.apache.openjpa.jdbc.schema.ColumnIO, boolean)">ValueHandler</A></CODE></B></DD> |
| <DD>Map the given value and return all mapped columns, or simply return an |
| array of unmapped default columns. The columns should have at least |
| their <code>Name</code> and <code>JavaType</code> properties set. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#map(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.String, org.apache.openjpa.jdbc.schema.ColumnIO, boolean)">map</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DD><CODE>name</CODE> - use as a base to form column name(s); the column names |
| of unmapped columns will automatically be made to fit |
| database limitations<DD><CODE>io</CODE> - I/O information about mapped columns; you do not |
| have to set this information if returning templates<DD><CODE>adapt</CODE> - whether to adapt the mapping or schema</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)"><!-- --></A><H3> |
| objectValueRequiresLoad</H3> |
| <PRE> |
| public boolean <B>objectValueRequiresLoad</B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)">ValueHandler</A></CODE></B></DD> |
| <DD>Return whether this handler potentially must load extra data to extract |
| the object value from its datastore representation. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)">objectValueRequiresLoad</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html#objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)">objectValueRequiresLoad</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">AbstractValueHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResultArgument(org.apache.openjpa.jdbc.meta.ValueMapping)"><!-- --></A><H3> |
| getResultArgument</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>getResultArgument</B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#getResultArgument(org.apache.openjpa.jdbc.meta.ValueMapping)">ValueHandler</A></CODE></B></DD> |
| <DD>Return the argument to pass to the result set when loading data |
| 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>, or null if none. If this value |
| occupies multiple columns, return an array with one element per |
| column. You may return null if all array elements would be null. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#getResultArgument(org.apache.openjpa.jdbc.meta.ValueMapping)">getResultArgument</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html#getResultArgument(org.apache.openjpa.jdbc.meta.ValueMapping)">getResultArgument</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">AbstractValueHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toDataStoreValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.jdbc.kernel.JDBCStore)"><!-- --></A><H3> |
| toDataStoreValue</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>toDataStoreValue</B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</A> store)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#toDataStoreValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.jdbc.kernel.JDBCStore)">ValueHandler</A></CODE></B></DD> |
| <DD>Translate the given value to its datastore equivalent. If this value |
| occupies multiple columns, return an object array with one element |
| per column. For relation id columns, return the state manager |
| the column depends on. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#toDataStoreValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.jdbc.kernel.JDBCStore)">toDataStoreValue</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html#toDataStoreValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.jdbc.kernel.JDBCStore)">toDataStoreValue</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">AbstractValueHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toObjectValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)"><!-- --></A><H3> |
| toObjectValue</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>toObjectValue</B>(<A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val, |
| <A HREF="../../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/JDBCStore.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCStore</A> store, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</A> fetch) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html" title="class or interface in java.sql">SQLException</A></PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#toObjectValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)">ValueHandler</A></CODE></B></DD> |
| <DD>Translate the given datastore value into its Java equivalent. If |
| the value occupies multiple columns, the given object will be an object |
| array with one entry per column. This method is only called if |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)"><CODE>ValueHandler.objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)</CODE></A> returns true. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#toObjectValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)">toObjectValue</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html" title="interface in org.apache.openjpa.jdbc.meta">ValueHandler</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html#toObjectValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object, org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.kernel.JDBCStore, org.apache.openjpa.jdbc.kernel.JDBCFetchConfiguration)">toObjectValue</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">AbstractValueHandler</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DD><CODE>sm</CODE> - the state manager that owns the value; may be null if |
| loading a projection |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html" title="class or interface in java.sql">SQLException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toRelationDataStoreValue(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| toRelationDataStoreValue</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>toRelationDataStoreValue</B>(<A HREF="../../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/RelationId.html#toRelationDataStoreValue(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.schema.Column)">RelationId</A></CODE></B></DD> |
| <DD>Return the serialized value for the given related object, now that |
| its id has been assigned. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/RelationId.html#toRelationDataStoreValue(org.apache.openjpa.kernel.OpenJPAStateManager, org.apache.openjpa.jdbc.schema.Column)">toRelationDataStoreValue</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/openjpa/jdbc/meta/RelationId.html" title="interface in org.apache.openjpa.jdbc.meta">RelationId</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ElementEmbedValueHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/ContainerFieldStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/openjpa/jdbc/meta/strats/EmbeddedClassStrategy.html" title="class in org.apache.openjpa.jdbc.meta.strats"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ElementEmbedValueHandler.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2009 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
