<!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.6.0_29) on Thu Nov 21 14:32:41 CET 2013 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
ValueHandler (OpenJPA Parent POM 2.3.0 API) | |
</TITLE> | |
<META NAME="date" CONTENT="2013-11-21"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
if (location.href.indexOf('is-external=true') == -1) { | |
parent.document.title="ValueHandler (OpenJPA Parent POM 2.3.0 API)"; | |
} | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<HR> | |
<!-- ========= 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/ValueHandler.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/StrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/openjpa/jdbc/meta/ValueHandler.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="ValueHandler.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: FIELD | CONSTR | <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</FONT> | |
<BR> | |
Interface ValueHandler</H2> | |
<DL> | |
<DT><B>All Superinterfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD> | |
</DL> | |
<DL> | |
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/AbstractValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">AbstractValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/BlobValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">BlobValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/ByteArrayValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ByteArrayValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/CharArrayStreamValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">CharArrayStreamValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/CharArrayValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">CharArrayValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/ClobValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ClobValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/ElementEmbedValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ElementEmbedValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/EmbedValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">EmbedValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/EnumValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">EnumValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/ImmutableValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ImmutableValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/ObjectIdValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">ObjectIdValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/UntypedPCValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">UntypedPCValueHandler</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/meta/strats/XMLValueHandler.html" title="class in org.apache.openjpa.jdbc.meta.strats">XMLValueHandler</A></DD> | |
</DL> | |
<HR> | |
<DL> | |
<DT><PRE>public interface <B>ValueHandler</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL> | |
</PRE> | |
<P> | |
Maps a value to a relational schema. Value handler are stateless. | |
<P> | |
<P> | |
<DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.4.0</DD> | |
<DT><B>Author:</B></DT> | |
<DD>Abe White</DD> | |
</DL> | |
<HR> | |
<P> | |
<!-- ========== 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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.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> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#isVersionable(org.apache.openjpa.jdbc.meta.ValueMapping)">isVersionable</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 the values managed by this handler can be used in | |
state image versioning.</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/ValueHandler.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://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" 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/ValueHandler.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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> | |
<TD><CODE><B><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></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueHandler.html#toObjectValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object)">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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> val)</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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> | |
<TD><CODE><B><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></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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> | |
</TABLE> | |
| |
<P> | |
<!-- ============ 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> | |
<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://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" 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>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> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><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="isVersionable(org.apache.openjpa.jdbc.meta.ValueMapping)"><!-- --></A><H3> | |
isVersionable</H3> | |
<PRE> | |
boolean <B>isVersionable</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm)</PRE> | |
<DL> | |
<DD>Return whether the values managed by this handler can be used in | |
state image versioning. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)"><!-- --></A><H3> | |
objectValueRequiresLoad</H3> | |
<PRE> | |
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>Return whether this handler potentially must load extra data to extract | |
the object value from its datastore representation. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getResultArgument(org.apache.openjpa.jdbc.meta.ValueMapping)"><!-- --></A><H3> | |
getResultArgument</H3> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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>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> | |
</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> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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>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> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="toObjectValue(org.apache.openjpa.jdbc.meta.ValueMapping, java.lang.Object)"><!-- --></A><H3> | |
toObjectValue</H3> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> val)</PRE> | |
<DL> | |
<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>objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)</CODE></A> returns false. | |
<P> | |
<DD><DL> | |
</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> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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://download.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> | |
<DL> | |
<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>objectValueRequiresLoad(org.apache.openjpa.jdbc.meta.ValueMapping)</CODE></A> returns true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><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://download.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></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/ValueHandler.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/StrategyInstaller.html" title="class in org.apache.openjpa.jdbc.meta"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/openjpa/jdbc/meta/ValueHandler.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="ValueHandler.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
Copyright © 2006–2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved. | |
</BODY> | |
</HTML> |