<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:44 PST 2013 --> <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> <title>RawSupport (Carbonado 1.2.3 API)</title> <meta name="date" content="2013-12-03"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="RawSupport (Carbonado 1.2.3 API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/RawSupport.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-files/index-1.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/amazon/carbonado/raw/RawSupport.html" target="_top">Frames</a></li> <li><a href="RawSupport.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">com.amazon.carbonado.raw</div> <h2 title="Interface RawSupport" class="title">Interface RawSupport<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Superinterfaces:</dt> <dd><a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a><S>, <a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a><S>, <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a><S></dd> </dl> <hr> <br> <pre>public interface <span class="strong">RawSupport<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> extends <a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a><S></pre> <div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw"><code>RawStorableGenerator</code></a>.</div> <dl><dt><span class="strong">Author:</span></dt> <dd>Brian S O'Neill</dd></dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html#decode(S, int, byte[])">decode</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> dest, int generation, byte[] data)</code> <div class="block">Used for decoding different generations of Storable.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html#getBlob(S, java.lang.String, long)">getBlob</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, java.lang.String name, long locator)</code> <div class="block">Returns the Blob for the given locator, returning null if not found.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html#getClob(S, java.lang.String, long)">getClob</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, java.lang.String name, long locator)</code> <div class="block">Returns the Clob for the given locator, returning null if not found.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html#getLocator(com.amazon.carbonado.lob.Blob)">getLocator</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> <div class="block">Returns the locator for the given Blob, returning zero if null.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html#getLocator(com.amazon.carbonado.lob.Clob)">getLocator</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> <div class="block">Returns the locator for the given Clob, returning zero if null.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html#store(S, byte[], byte[])">store</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, byte[] key, byte[] value)</code> <div class="block">Try to store the entry referenced by the given key with the given value.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html#tryDelete(S, byte[])">tryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, byte[] key)</code> <div class="block">Try to delete the entry referenced by the given key.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html#tryInsert(S, byte[], byte[])">tryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, byte[] key, byte[] value)</code> <div class="block">Try to insert the entry referenced by the given key with the given value.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html#tryLoad(S, byte[])">tryLoad</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, byte[] key)</code> <div class="block">Try to load the entry referenced by the given key, but return null if not found.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.gen.MasterSupport"> <!-- --> </a> <h3>Methods inherited from interface com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a></h3> <code><a href="../../../../com/amazon/carbonado/gen/MasterSupport.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.gen.TriggerSupport"> <!-- --> </a> <h3>Methods inherited from interface com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></h3> <code><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getDeleteTrigger()">getDeleteTrigger</a>, <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getInsertTrigger()">getInsertTrigger</a>, <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getLoadTrigger()">getLoadTrigger</a>, <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getUpdateTrigger()">getUpdateTrigger</a>, <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#locallyDisableLoadTrigger()">locallyDisableLoadTrigger</a>, <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#locallyEnableLoadTrigger()">locallyEnableLoadTrigger</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.gen.StorableSupport"> <!-- --> </a> <h3>Methods inherited from interface com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a></h3> <code><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html#getRootRepository()">getRootRepository</a>, <a href="../../../../com/amazon/carbonado/gen/StorableSupport.html#isPropertySupported(java.lang.String)">isPropertySupported</a></code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="tryLoad(com.amazon.carbonado.Storable,byte[])"> <!-- --> </a><a name="tryLoad(S, byte[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>tryLoad</h4> <pre>byte[] tryLoad(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, byte[] key) throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> <div class="block">Try to load the entry referenced by the given key, but return null if not found.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - user storable which will have its properties set</dd><dd><code>key</code> - non-null key to search for</dd> <dt><span class="strong">Returns:</span></dt><dd>non-null value that was found, or null if not found</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> </li> </ul> <a name="tryInsert(com.amazon.carbonado.Storable,byte[],byte[])"> <!-- --> </a><a name="tryInsert(S, byte[], byte[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>tryInsert</h4> <pre>boolean tryInsert(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, byte[] key, byte[] value) throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> <div class="block">Try to insert the entry referenced by the given key with the given value.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - user storable that key and value were derived from</dd><dd><code>key</code> - non-null key to insert</dd><dd><code>value</code> - non-null value to insert</dd> <dt><span class="strong">Returns:</span></dt><dd>false if unique constraint prevents insert</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> </li> </ul> <a name="store(com.amazon.carbonado.Storable,byte[],byte[])"> <!-- --> </a><a name="store(S, byte[], byte[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>store</h4> <pre>void store(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, byte[] key, byte[] value) throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> <div class="block">Try to store the entry referenced by the given key with the given value. If the entry does not exist, insert it. Otherwise, update it.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - user storable that key and value were derived from</dd><dd><code>key</code> - non-null key to store</dd><dd><code>value</code> - non-null value to store</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> </li> </ul> <a name="tryDelete(com.amazon.carbonado.Storable,byte[])"> <!-- --> </a><a name="tryDelete(S, byte[])"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>tryDelete</h4> <pre>boolean tryDelete(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, byte[] key) throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> <div class="block">Try to delete the entry referenced by the given key.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - user supplied storable object</dd><dd><code>key</code> - non-null key to delete</dd> <dt><span class="strong">Returns:</span></dt><dd>true if entry existed and is now deleted</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> </li> </ul> <a name="getBlob(com.amazon.carbonado.Storable,java.lang.String,long)"> <!-- --> </a><a name="getBlob(S, java.lang.String, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getBlob</h4> <pre><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> getBlob(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, java.lang.String name, long locator) throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> <div class="block">Returns the Blob for the given locator, returning null if not found.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable that contains Blob</dd><dd><code>name</code> - name of Blob property</dd><dd><code>locator</code> - Blob locator</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> </li> </ul> <a name="getLocator(com.amazon.carbonado.lob.Blob)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLocator</h4> <pre>long getLocator(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob) throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> <div class="block">Returns the locator for the given Blob, returning zero if null.</div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if blob is unrecognized</dd></dl> </li> </ul> <a name="getClob(com.amazon.carbonado.Storable,java.lang.String,long)"> <!-- --> </a><a name="getClob(S, java.lang.String, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getClob</h4> <pre><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> getClob(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, java.lang.String name, long locator) throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> <div class="block">Returns the Clob for the given locator, returning null if not found.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable that contains Blob</dd><dd><code>name</code> - name of Clob property</dd><dd><code>locator</code> - Clob locator</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> </li> </ul> <a name="getLocator(com.amazon.carbonado.lob.Clob)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLocator</h4> <pre>long getLocator(<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob) throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> <div class="block">Returns the locator for the given Clob, returning zero if null.</div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if blob is unrecognized</dd></dl> </li> </ul> <a name="decode(com.amazon.carbonado.Storable,int,byte[])"> <!-- --> </a><a name="decode(S, int, byte[])"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>decode</h4> <pre>void decode(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> dest, int generation, byte[] data) throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> <div class="block">Used for decoding different generations of Storable. If layout generations are not supported, simply throw a CorruptEncodingException.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>dest</code> - storable to receive decoded properties</dd><dd><code>generation</code> - storable layout generation number</dd><dd><code>data</code> - decoded into properties, some of which may be dropped if destination storable doesn't have it</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></code> - if generation is unknown or if data cannot be decoded</dd><dt><span class="strong">Since:</span></dt> <dd>1.2.1</dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/RawSupport.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-files/index-1.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/amazon/carbonado/raw/RawSupport.html" target="_top">Frames</a></li> <li><a href="RawSupport.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> </body> </html>