diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html | 375 |
1 files changed, 375 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html b/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html new file mode 100644 index 0000000..9ce8482 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/StoredIndexInfo.html @@ -0,0 +1,375 @@ +<!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:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StoredIndexInfo (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="StoredIndexInfo (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/StoredIndexInfo.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/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" target="_top">Frames</a></li> +<li><a href="StoredIndexInfo.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.repo.indexed</div> +<h2 title="Interface StoredIndexInfo" class="title">Interface StoredIndexInfo</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/Storable.html" title="interface in com.amazon.carbonado">Storable</a>, <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>, <a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">@PrimaryKey</a>(<a href="../../../../../com/amazon/carbonado/PrimaryKey.html#value()">value</a>="indexName") +<a href="../../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">@Independent</a> +<a href="../../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">@Alias</a>(<a href="../../../../../com/amazon/carbonado/Alias.html#value()">value</a>="CARBONADO_INDEX_INFO") +public interface <span class="strong">StoredIndexInfo</span> +extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>, <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>, <a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></pre> +<div class="block">Stores basic information about the indexes managed by IndexedRepository. + + <p>Note: This storable cannot have indexes defined, since it is used to + discover information about indexes. It would create a cyclic dependency.</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getCreationTimestamp()">getCreationTimestamp</a></strong>()</code> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getExtraData()">getExtraData</a></strong>()</code> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getIndexName()">getIndexName</a></strong>()</code> +<div class="block">Returns the index name, which is also a valid index name + descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getIndexTypeDescriptor()">getIndexTypeDescriptor</a></strong>()</code> +<div class="block">Returns the types of the index properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredIndexInfo instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setCreationTimestamp(long)">setCreationTimestamp</a></strong>(long timestamp)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setExtraData(byte[])">setExtraData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setIndexName(java.lang.String)">setIndexName</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setIndexTypeDescriptor(java.lang.String)">setIndexTypeDescriptor</a></strong>(java.lang.String descriptor)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setVersionNumber(int)">setVersionNumber</a></strong>(int version)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Storable"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></h3> +<code><a href="../../../../../com/amazon/carbonado/Storable.html#copy()">copy</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#delete()">delete</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#hashCode()">hashCode</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#insert()">insert</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#load()">load</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#prepare()">prepare</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#storableType()">storableType</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#toString()">toString</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#update()">update</a>, <a href="../../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</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="getIndexName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexName</h4> +<pre>java.lang.String getIndexName()</pre> +<div class="block">Returns the index name, which is also a valid index name + descriptor. This descriptor is defined by <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a>. The name descriptor does not + contain type information.</div> +</li> +</ul> +<a name="setIndexName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexName</h4> +<pre>void setIndexName(java.lang.String name)</pre> +</li> +</ul> +<a name="getIndexTypeDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexTypeDescriptor</h4> +<pre><a href="../../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getIndexTypeDescriptor()</pre> +<div class="block">Returns the types of the index properties. This descriptor is defined by + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a>.</div> +</li> +</ul> +<a name="setIndexTypeDescriptor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexTypeDescriptor</h4> +<pre>void setIndexTypeDescriptor(java.lang.String descriptor)</pre> +</li> +</ul> +<a name="getCreationTimestamp()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationTimestamp</h4> +<pre>long getCreationTimestamp()</pre> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</li> +</ul> +<a name="setCreationTimestamp(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCreationTimestamp</h4> +<pre>void setCreationTimestamp(long timestamp)</pre> +</li> +</ul> +<a name="getVersionNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionNumber</h4> +<pre><a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +int getVersionNumber()</pre> +<div class="block">Record version number for this StoredIndexInfo instance. Some encoding + strategies require a version number.</div> +</li> +</ul> +<a name="setVersionNumber(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVersionNumber</h4> +<pre>void setVersionNumber(int version)</pre> +</li> +</ul> +<a name="getExtraData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExtraData</h4> +<pre><a href="../../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +byte[] getExtraData()</pre> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records. This record cannot evolve + because an evolution strategy likely depends on this interface remaining + stable, avoiding a cyclic dependency.</div> +</li> +</ul> +<a name="setExtraData(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setExtraData</h4> +<pre>void setExtraData(byte[] data)</pre> +</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/StoredIndexInfo.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/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" target="_top">Frames</a></li> +<li><a href="StoredIndexInfo.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> |