TupleMarshalledBinding.html [plain text]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Wed Dec 03 16:22:07 EST 2003 -->
<TITLE>
TupleMarshalledBinding (Sleepycat Software, Inc. - Berkeley DB Java API)
</TITLE>
<META NAME="keywords" CONTENT="com.sleepycat.bdb.bind.tuple.TupleMarshalledBinding,TupleMarshalledBinding class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../style.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="TupleMarshalledBinding (Sleepycat Software, Inc. - Berkeley DB Java API)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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/TupleMarshalledBinding.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>
<b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInputBinding.html"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="TupleMarshalledBinding.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.bdb.bind.tuple</FONT>
<BR>
Class TupleMarshalledBinding</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
|
+--<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html">com.sleepycat.bdb.bind.tuple.TupleBinding</A>
|
+--<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">DataBinding</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>TupleMarshalledBinding</B><DT>extends <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html">TupleBinding</A></DL>
<P>
A concrete key or value binding that uses the <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleData.html"><CODE>MarshalledTupleData</CODE></A>
interface. It works by calling the methods of the <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/MarshalledTupleData.html"><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>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</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">TupleFormat</A> format,
<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A> cls)</CODE>
<BR>
Creates a tuple marshalled binding object.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></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.3/docs/api/java/lang/Object.html">Object</A></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">TupleInput</A> input)</CODE>
<BR>
Constructs a key or value object from <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html"><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>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> object,
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html">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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class com.sleepycat.bdb.bind.tuple.<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html">TupleBinding</A></B></TD>
</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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</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">TupleFormat</A> format,
<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Class.html">Class</A> 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"><CODE>MarshalledTupleData</CODE></A> interface.</p>
<P>
<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>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="dataToObject(com.sleepycat.bdb.bind.tuple.TupleInput)"><!-- --></A><H3>
dataToObject</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> <B>dataToObject</B>(<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html">TupleInput</A> input)
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html">TupleBinding</A></CODE></B></DD>
<DD>Constructs a key or value object from <A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInput.html"><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">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.
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></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>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> object,
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html">TupleOutput</A> output)
throws <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleBinding.html">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">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.
<DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/io/IOException.html">IOException</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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/TupleMarshalledBinding.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>
<b>Berkeley DB</b><br><font size="-1"> version 4.2.52</font></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleInputBinding.html"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/sleepycat/bdb/bind/tuple/TupleOutput.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="TupleMarshalledBinding.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><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>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<font size=1><a href="../../../../../../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</BODY>
</HTML>