diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html | 603 |
1 files changed, 603 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html new file mode 100644 index 0000000..ee55d20 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.html @@ -0,0 +1,603 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>CustomStorableCodec (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="CustomStorableCodec (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/CustomStorableCodec.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/CompressionType.html" title="enum in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface 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/CustomStorableCodec.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodec.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><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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="Class CustomStorableCodec" class="title">Class CustomStorableCodec<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.CustomStorableCodec<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">CustomStorableCodec<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></pre> +<div class="block">Allows codecs to be defined for storables that have a custom encoding.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><code>CustomStorableCodecFactory</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw">CustomStorableCodec.InstanceFactory</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#CustomStorableCodec(java.lang.Class, boolean)">CustomStorableCodec</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> type, + boolean isMaster)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#CustomStorableCodec(java.lang.Class, boolean, com.amazon.carbonado.raw.RawSupport)">CustomStorableCodec</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> support)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#buildPkIndex(java.lang.String...)">buildPkIndex</a></strong>(java.lang.String... propertyNames)</code> +<div class="block">Convenient way to define the clustered primary key index + descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#decodeData(S, byte[])">decodeData</a></strong>(<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> storable, + byte[] bytes)</code> +<div class="block">Decode the data into properties of the storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#decodePrimaryKey(S, byte[])">decodePrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> storable, + byte[] bytes)</code> +<div class="block">Decode the primary key into properties of the storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#encodeData(S)">encodeData</a></strong>(<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> storable)</code> +<div class="block">Encode all properties of the storable excluding the primary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#encodePrimaryKey(java.lang.Object[])">encodePrimaryKey</a></strong>(java.lang.Object[] values)</code> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#encodePrimaryKey(S)">encodePrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> storable)</code> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,? extends <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Convenient access to all the storable properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the type of Storable produced by this codec.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#getSupport()">getSupport</a></strong>()</code> +<div class="block">Returns the default <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> object that is supplied to + Storable instances produced by this codec.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate()">instantiate</a></strong>()</code> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(byte[], byte[])">instantiate</a></strong>(byte[] key, + byte[] value)</code> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> support)</code> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> support, + byte[] key, + byte[] value)</code> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.raw.StorableCodec"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></h3> +<code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#decode(S, int, byte[])">decode</a>, <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(java.lang.Object[], int, int)">encodePrimaryKey</a>, <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(S, int, int)">encodePrimaryKey</a>, <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKeyPrefix()">encodePrimaryKeyPrefix</a>, <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a>, <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyPrefixLength()">getPrimaryKeyPrefixLength</a>, <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[])">instantiate</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CustomStorableCodec(java.lang.Class, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CustomStorableCodec</h4> +<pre>public CustomStorableCodec(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> type, + boolean isMaster) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if Storable is not supported</dd></dl> +</li> +</ul> +<a name="CustomStorableCodec(java.lang.Class, boolean, com.amazon.carbonado.raw.RawSupport)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CustomStorableCodec</h4> +<pre>public CustomStorableCodec(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> support) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if Storable is not supported</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>public java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getStorableType()">StorableCodec</a></code></strong></div> +<div class="block">Returns the type of Storable produced by this codec.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +</dl> +</li> +</ul> +<a name="instantiate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre>public <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> instantiate()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate()">StorableCodec</a></code></strong></div> +<div class="block">Instantiate a Storable with no key or value defined yet. The default + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> is supplied to the instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate()">instantiate</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="instantiate(byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre>public <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> instantiate(byte[] key, + byte[] value) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[], byte[])">StorableCodec</a></code></strong></div> +<div class="block">Instantiate a Storable with a specific key and value. The default + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> is supplied to the instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[], byte[])">instantiate</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></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><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="instantiate(com.amazon.carbonado.raw.RawSupport)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre>public <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> instantiate(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> support)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">StorableCodec</a></code></strong></div> +<div class="block">Instantiate a Storable with no key or value defined yet. Any + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> can be supplied to the instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>support</code> - binds generated storable with a storage layer</dd></dl> +</li> +</ul> +<a name="instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre>public <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> instantiate(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> support, + byte[] key, + byte[] value) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">StorableCodec</a></code></strong></div> +<div class="block">Instantiate a Storable with a specific key and value. Any + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> can be supplied to the instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>support</code> - binds generated storable with a storage layer</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="encodePrimaryKey(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="encodePrimaryKey(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>public byte[] encodePrimaryKey(<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> storable)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(S)">StorableCodec</a></code></strong></div> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(S)">encodePrimaryKey</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - extract primary key properties from this instance</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodePrimaryKey(java.lang.Object[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>public byte[] encodePrimaryKey(java.lang.Object[] values)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(java.lang.Object[])">StorableCodec</a></code></strong></div> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(java.lang.Object[])">encodePrimaryKey</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - values to build into a key. It must be long enough to + accommodate all primary key properties.</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="getSupport()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupport</h4> +<pre>public <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> getSupport()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getSupport()">StorableCodec</a></code></strong></div> +<div class="block">Returns the default <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> object that is supplied to + Storable instances produced by this codec.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getSupport()">getSupport</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getAllProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllProperties</h4> +<pre>public java.util.Map<java.lang.String,? extends <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>>> getAllProperties()</pre> +<div class="block">Convenient access to all the storable properties.</div> +</li> +</ul> +<a name="buildPkIndex(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildPkIndex</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>> buildPkIndex(java.lang.String... propertyNames)</pre> +<div class="block">Convenient way to define the clustered primary key index + descriptor. Direction can be specified by prefixing the property name + with a '+' or '-'. If unspecified, direction is assumed to be ascending.</div> +</li> +</ul> +<a name="decodePrimaryKey(com.amazon.carbonado.Storable,byte[])"> +<!-- --> +</a><a name="decodePrimaryKey(S, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodePrimaryKey</h4> +<pre>public abstract void decodePrimaryKey(<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> storable, + byte[] bytes) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decode the primary key into properties of the storable.</div> +<dl><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></dd></dl> +</li> +</ul> +<a name="encodeData(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="encodeData(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeData</h4> +<pre>public abstract byte[] encodeData(<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> storable)</pre> +<div class="block">Encode all properties of the storable excluding the primary key.</div> +</li> +</ul> +<a name="decodeData(com.amazon.carbonado.Storable,byte[])"> +<!-- --> +</a><a name="decodeData(S, byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decodeData</h4> +<pre>public abstract void decodeData(<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> storable, + byte[] bytes) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decode the data into properties of the storable.</div> +<dl><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></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/CustomStorableCodec.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/CompressionType.html" title="enum in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface 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/CustomStorableCodec.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodec.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><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> |