<!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_18) on Thu Dec 02 16:59:38 UTC 2010 -->
<TITLE>
TupleMarshalledBinding
</TITLE>
<META NAME="date" CONTENT="2010-12-02">
<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="TupleMarshalledBinding";
}
}
</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="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="../../../../../com/sleepycat/bdb/bind/tuple/TupleInputBinding.html" title="class in com.sleepycat.bdb.bind.tuple"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bdb.bind.tuple"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/sleepycat/bdb/bind/tuple/TupleMarshalledBinding.html" target="_top"><B>FRAMES</B></A>
<A HREF="TupleMarshalledBinding.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 | <A HREF="#fields_inherited_from_class_com.sleepycat.bdb.bind.tuple.TupleBinding">FIELD</A> | <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">
com.sleepycat.bdb.bind.tuple</FONT>
<BR>
Class TupleMarshalledBinding</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bdb.bind.tuple">com.sleepycat.bdb.bind.tuple.TupleBinding</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.bdb.bind.tuple.TupleMarshalledBinding</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/sleepycat/bdb/bind/DataBinding.html" title="interface in com.sleepycat.bdb.bind">DataBinding</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>TupleMarshalledBinding</B><DT>extends <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bdb.bind.tuple">TupleBinding</A></DL>
</PRE>
<P>
A concrete key or value binding that uses the <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleData.html" title="interface in com.sleepycat.bdb.bind.tuple"><CODE>MarshalledTupleData</CODE></A>
interface. It works by calling the methods of the <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleData.html" title="interface in com.sleepycat.bdb.bind.tuple"><CODE>MarshalledTupleData</CODE></A> interface, which must be implemented by the key or
value class, to convert between the key or value data and the object.
use the <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html#TupleInput(com.sleepycat.bdb.bind.tuple.TupleOutput)"><CODE>TupleInput.TupleInput(TupleOutput)</CODE></A> constructor.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_com.sleepycat.bdb.bind.tuple.TupleBinding"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class com.sleepycat.bdb.bind.tuple.<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bdb.bind.tuple">TupleBinding</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html#format">format</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== 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="../../../../../com/sleepycat/bdb/bind/tuple/TupleMarshalledBinding.html#TupleMarshalledBinding(com.sleepycat.bdb.bind.tuple.TupleFormat, java.lang.Class)">TupleMarshalledBinding</A></B>(<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleFormat.html" title="class in com.sleepycat.bdb.bind.tuple">TupleFormat</A> format,
java.lang.Class cls)</CODE>
<BR>
Creates a tuple marshalled binding object.</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> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleMarshalledBinding.html#dataToObject(com.sleepycat.bdb.bind.tuple.TupleInput)">dataToObject</A></B>(<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html" title="class in com.sleepycat.bdb.bind.tuple">TupleInput</A> input)</CODE>
<BR>
Constructs a key or value object from <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html" title="class in com.sleepycat.bdb.bind.tuple"><CODE>TupleInput</CODE></A> data.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleMarshalledBinding.html#objectToData(java.lang.Object, com.sleepycat.bdb.bind.tuple.TupleOutput)">objectToData</A></B>(java.lang.Object object,
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bdb.bind.tuple">TupleOutput</A> output)</CODE>
<BR>
Converts a key or value object to a tuple data.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_com.sleepycat.bdb.bind.tuple.TupleBinding"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.bdb.bind.tuple.<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bdb.bind.tuple">TupleBinding</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html#dataToObject(com.sleepycat.bdb.bind.DataBuffer)">dataToObject</A>, <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html#getDataFormat()">getDataFormat</A>, <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html#getPrimitiveBinding(java.lang.Class, com.sleepycat.bdb.bind.tuple.TupleFormat)">getPrimitiveBinding</A>, <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html#objectToData(java.lang.Object, com.sleepycat.bdb.bind.DataBuffer)">objectToData</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.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="TupleMarshalledBinding(com.sleepycat.bdb.bind.tuple.TupleFormat, java.lang.Class)"><!-- --></A><H3>
TupleMarshalledBinding</H3>
<PRE>
public <B>TupleMarshalledBinding</B>(<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleFormat.html" title="class in com.sleepycat.bdb.bind.tuple">TupleFormat</A> format,
java.lang.Class cls)</PRE>
<DL>
<DD>Creates a tuple marshalled binding object.
<p>The given class is used to instantiate key or value objects using
<CODE>Class.forName(java.lang.String)</CODE>, and therefore must be a public class and have a
public no-arguments constructor. It must also implement the <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleData.html" title="interface in com.sleepycat.bdb.bind.tuple"><CODE>MarshalledTupleData</CODE></A> interface.</p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - is the format of the new binding.<DD><CODE>cls</CODE> - is the class of the key or value objects.</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="dataToObject(com.sleepycat.bdb.bind.tuple.TupleInput)"><!-- --></A><H3>
dataToObject</H3>
<PRE>
public java.lang.Object <B>dataToObject</B>(<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html" title="class in com.sleepycat.bdb.bind.tuple">TupleInput</A> input)
throws java.io.IOException</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html#dataToObject(com.sleepycat.bdb.bind.tuple.TupleInput)">TupleBinding</A></CODE></B></DD>
<DD>Constructs a key or value object from <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html" title="class in com.sleepycat.bdb.bind.tuple"><CODE>TupleInput</CODE></A> data.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html#dataToObject(com.sleepycat.bdb.bind.tuple.TupleInput)">dataToObject</A></CODE> in class <CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bdb.bind.tuple">TupleBinding</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>input</CODE> - is the tuple key or value data.
<DT><B>Returns:</B><DD>the key or value object constructed from the data.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="objectToData(java.lang.Object, com.sleepycat.bdb.bind.tuple.TupleOutput)"><!-- --></A><H3>
objectToData</H3>
<PRE>
public void <B>objectToData</B>(java.lang.Object object,
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bdb.bind.tuple">TupleOutput</A> output)
throws java.io.IOException</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html#objectToData(java.lang.Object, com.sleepycat.bdb.bind.tuple.TupleOutput)">TupleBinding</A></CODE></B></DD>
<DD>Converts a key or value object to a tuple data.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html#objectToData(java.lang.Object, com.sleepycat.bdb.bind.tuple.TupleOutput)">objectToData</A></CODE> in class <CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html" title="class in com.sleepycat.bdb.bind.tuple">TupleBinding</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>object</CODE> - is the key or value object.<DD><CODE>output</CODE> - is the tuple data to which the key or value should be
written.
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</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="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="../../../../../com/sleepycat/bdb/bind/tuple/TupleInputBinding.html" title="class in com.sleepycat.bdb.bind.tuple"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html" title="class in com.sleepycat.bdb.bind.tuple"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/sleepycat/bdb/bind/tuple/TupleMarshalledBinding.html" target="_top"><B>FRAMES</B></A>
<A HREF="TupleMarshalledBinding.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 | <A HREF="#fields_inherited_from_class_com.sleepycat.bdb.bind.tuple.TupleBinding">FIELD</A> | <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>
</BODY>
</HTML>
