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/package-summary.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/package-summary.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/package-summary.html | 545 |
1 files changed, 545 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/package-summary.html b/apidocs/com/amazon/carbonado/package-summary.html new file mode 100644 index 0000000..e220503 --- /dev/null +++ b/apidocs/com/amazon/carbonado/package-summary.html @@ -0,0 +1,545 @@ +<!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>com.amazon.carbonado (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="com.amazon.carbonado (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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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>Prev Package</li> +<li><a href="../../../com/amazon/carbonado/adapter/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package com.amazon.carbonado</h1> +<div class="docSummary"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</div> +<p>See: <a href="#package_description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></td> +<td class="colLast"> +<div class="block">Represents the results of a <a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a>'s fetch + operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Supports complex retrieval and deletion of <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></td> +<td class="colLast"> +<div class="block">Controller instance can be used to abort query operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></td> +<td class="colLast"> +<div class="block">A Repository represents a database for <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> + instances.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Standard interface for building up configuration and opening a <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>></td> +<td class="colLast"> +<div class="block">A data access object in a <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Access for a specific type of <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> from a <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></td> +<td class="colLast"> +<div class="block">Transactions define atomic operations which can be committed or aborted as a + unit.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></td> +<td class="colLast"> +<div class="block">Can be used with <a href="../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><code>RepositoryBuilder</code></a> to automatically register + triggers as Storable types become available.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></td> +<td class="colLast"> +<div class="block">Timeout controller, for aborting long running queries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></td> +<td class="colLast"> +<div class="block">Callback mechanism to allow custom code to run when a storable is + persisted.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></td> +<td class="colLast"> +<div class="block">Describes a transaction isolation level.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> +<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Exception</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></td> +<td class="colLast"> +<div class="block">Indicates that a <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> could not be + instantiated given the configuration information provided to a <a href="../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><code>RepositoryBuilder</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></td> +<td class="colLast"> +<div class="block">A ConstraintException is thrown if the <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> storage layer + detects any kind of constraint violation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></td> +<td class="colLast"> +<div class="block">A CorruptEncodingException is caused when decoding an encoded record fails.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">FetchDeadlockException</a></td> +<td class="colLast"> +<div class="block">Thrown if a fetch operation fails because it was selected to resolve a + deadlock.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></td> +<td class="colLast"> +<div class="block">A FetchException is caused by a failure when selecting records from a <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">FetchInterruptedException</a></td> +<td class="colLast"> +<div class="block">Thrown from a fetch operation that was canceled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></td> +<td class="colLast"> +<div class="block">A FetchMultipleException is thrown when a fetch operation returned more + than one record when at most one was expected.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></td> +<td class="colLast"> +<div class="block">A FetchNoneException is thrown when a fetch operation returned no records + when at least one was expected.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></td> +<td class="colLast"> +<div class="block">Thrown if a fetch operation fails because lock acquisition timed out.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></td> +<td class="colLast"> +<div class="block">A MalformedArgumentException is thrown after detailed analysis on an + argument determined it was not suitable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></td> +<td class="colLast"> +<div class="block">A MalformedFilterException indicates that a + <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>query filter</code></a> is invalid.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></td> +<td class="colLast"> +<div class="block">A MalformedTypeException indicates that a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> is defined in a + way that violates the requirements for Storable objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></td> +<td class="colLast"> +<div class="block">Indicates that a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> doesn't exactly match up with an external + schema.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">NonDurableCommitException</a></td> +<td class="colLast"> +<div class="block">Thrown during a transaction commit if durability guarantees cannot be met.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></td> +<td class="colLast"> +<div class="block">An OptimisticLockException is thrown if the <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> is using + optimistic locking for concurrency control, and lock aquisition failed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">PersistDeadlockException</a></td> +<td class="colLast"> +<div class="block">Thrown if a persist operation fails because it was selected to resolve a + deadlock.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></td> +<td class="colLast"> +<div class="block">Thrown when a persist operation was denied either because the repository is + in read-only mode, or the connection does not have permission.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></td> +<td class="colLast"> +<div class="block">A PersistException is caused by a failure when inserting, updating, or + deleting records from a <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">PersistInterruptedException</a></td> +<td class="colLast"> +<div class="block">Thrown from a persist operation that was canceled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></td> +<td class="colLast"> +<div class="block">A PersistMultipleException is thrown when a persist operation would have + applied to more than one record when at most one was expected.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></td> +<td class="colLast"> +<div class="block">A PersistNoneException is thrown when a persist operation applied to no + records when at least one was expected.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">PersistTimeoutException</a></td> +<td class="colLast"> +<div class="block">Thrown if a persist operation fails because lock acquisition timed out.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></td> +<td class="colLast"> +<div class="block">General checked exception thrown when accessing a <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></td> +<td class="colLast"> +<div class="block">Indicates that an action cannot be supported by the <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> it is being requested from.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></td> +<td class="colLast"> +<div class="block">A UniqueConstraintException is thrown if the <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> storage + layer has a unique constraint check defined for a property, and a violation + has been detected.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></td> +<td class="colLast"> +<div class="block">Thrown by a <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> which cannot support a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> which + is declared as <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>Independent</code></a> or <a href="../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado"><code>Authoritative</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> +<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Annotation Type</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a></td> +<td class="colLast"> +<div class="block">Identifies alternate names for a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> or a Storable property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">AlternateKeys</a></td> +<td class="colLast"> +<div class="block">List of alternate keys for a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">Authoritative</a></td> +<td class="colLast"> +<div class="block">Indicates that all accesses to this <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> must come from an + authoritative source.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Automatic.html" title="annotation in com.amazon.carbonado">Automatic</a></td> +<td class="colLast"> +<div class="block">Identifies a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property capable of selecting its own value on + insert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado">Derived</a></td> +<td class="colLast"> +<div class="block">Identifies a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property which is not directly persisted, but + is instead derived from other property values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a></td> +<td class="colLast"> +<div class="block">A hint for a dependent <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> to allow a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property or type + to be undefined in the underlying schema.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado">Index</a></td> +<td class="colLast"> +<div class="block">An Index annotation provides a hint to the storage layer allowing <a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>queries</code></a> to be performed more quickly.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado">Indexes</a></td> +<td class="colLast"> +<div class="block">The Indexes annotation is applied to a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> for specifying all + the <a href="../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><code>indexes</code></a> it should have.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado">Join</a></td> +<td class="colLast"> +<div class="block">Identifies a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as defining a join relationship + with another Storable type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado">Key</a></td> +<td class="colLast"> +<div class="block">Identifies a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as being a member of an alternate + key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado">Name</a></td> +<td class="colLast"> +<div class="block">Overrides the primary name of a Storable property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Nullable</a></td> +<td class="colLast"> +<div class="block">Identifies that a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property can have a null value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/PartitionKey.html" title="annotation in com.amazon.carbonado">PartitionKey</a></td> +<td class="colLast"> +<div class="block">Identifies a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as being a member of the partition key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a></td> +<td class="colLast"> +<div class="block">Identifies a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as being a member of the primary + key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado">Sequence</a></td> +<td class="colLast"> +<div class="block">Identifies a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property capable of selecting its own value on + insert, by a named sequence.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a></td> +<td class="colLast"> +<div class="block">Designates a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as being the authoritative version + number for the entire Storable instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado Description">Package com.amazon.carbonado Description</h2> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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>Prev Package</li> +<li><a href="../../../com/amazon/carbonado/adapter/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<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> |